任务式对话实体接口

实体-删除接口

请求地址

请求参数

Request parameters

Parameter Type Optional Description
id Integer false 实体id.
force Integer true 是否强制删除 0:否 1:是 (默认为0).

请求结果

Path Type Optional Description
code Integer true 状态码
message String true 返回信息
visible Boolean true
data Object true 返回内容

示例

$ curl 'https://km.udesk.cn/api/v1/entity/12?force=0&email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception":null,
    "paging":null,
    "data": null,
    "extra":null
}

实体-更新接口

请求地址

请求参数

Request fields

Path Type Optional Description
robotId Integer false 机器人ID.
name String false 名称.
apiName String false api名称 (api名称只能为字母、数字或下划线).
remark String true 描述 (描述长度不能超过255字符).
regex String true 正则值 .
valueList Array true 实体值列表 .
valueList[].id Integer true 实体值ID
valueList[].originalValue String true 实体值名称
valueList[].changeType Integer true 修改状态(0.未修改 1.新增 2.修改 3.删除)
valueList[].similarValueList Array true 近义值数组
valueList[].similarValueList[] String true 近义值

请求结果

Path Type Optional Description
code Integer true 状态码
message String true 返回信息
visible Boolean true
data Object true 返回内容

示例

$ curl 'https://km.udesk.cn/api/v1/entity/12?email=admin@udesk.cn&timestamp=1559016375&sign=7f31519fd01b85d4043b9413d1fad225718eb914' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "apiName": "api",
    "name": "实体名称",
    "regex": "",
    "remark": "描述",
    "robotId": 83,
    "valueList": [
     {
       "changeType": 2,
       "id": 23,
       "originalValue": "实体值",
       "similarValueList": [
         "近义词"
       ]
     }
    ]
  }'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception":null,
    "paging":null,
    "data": null,
    "extra":null
}

实体-保存接口

请求地址

请求参数

Request fields

Path Type Optional Description
robotId Integer false 机器人ID.
name String false 名称.
apiName String false api名称 (api名称只能为字母、数字或下划线).
regex String true 正则值 .
remark String true 描述 (描述长度不能超过255字符).

请求结果

Path Type Optional Description
code Integer true 状态码
message String true 返回信息
visible Boolean true
data Object true 返回内容
data.id Array true 智能提示问题列表.
data[].id Integer true ID.
data[].robotId Integer true 机器人ID.
data[].name String true 名称.
data[].apiName String true api名称.
data[].type Integer true 类型(1.自定义 2.系统).
data[].status Integer true 状态(0.禁用 1.启用).
data[].regex String true 正则值.
data[].sysEntityIdentifier String true 系统标识描述符.
data[].remark String true 描述.
data[].orders Integer true 排序.
data[].valueList Array true 实体值列表.
data[].valueList[].id Integer true 实体值ID
data[].valueList[].originalValue String true 实体值名称
data[].valueList[].changeType Integer true 修改状态(0.未修改 1.新增 2.修改 3.删除)
data[].valueList[].similarValueList Array true 近义值数组
data[].valueList[].similarValueList[] String true 近义值

示例

$ curl 'https://km.udesk.cn/api/v1/entity?email=admin@udesk.cn&timestamp=1559016113&sign=f16d7f6fcc3fbab73855f4510cd4904f0f60e258' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "robotId" : 83,
    "name" : "实体名称",
    "apiName":"api",
    "remark":"描述"
  }'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "id": 2850,
        "robotId": 83,
        "name": "实体名称",
        "apiName": "api",
        "type": 1,
        "status": null,
        "regex": null,
        "sysEntityIdentifier": null,
        "remark": "描述",
        "orders": null,
        "valueList": null
    },
    "extra": null
}

实体-启用禁用接口接口

请求地址

请求参数

Request fields

path Type Optional Description
id Integer false 实体id.
status Integer false 启用禁用 0:禁用 1:启用.

请求结果

Path Type Optional Description
code Integer true 状态码
message String true 返回信息
visible Boolean true
data Object true 返回内容

示例

$ curl 'https://km.udesk.cn/api/v1/entity/12/status/1?email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception":null,
    "paging":null,
    "data": null,
    "extra":null
}

实体-获取详情接口

请求地址

请求参数

Request fields

path Type Optional Description
id Integer false 实体id.

请求结果

Path Type Optional Description
code Integer true 状态码
message String true 返回信息
visible Boolean true
data Object true 返回内容

示例

$ curl 'https://km.udesk.cn/api/v1/entity/2850?email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "id": 2850,
        "robotId": 83,
        "name": "实体名称",
        "apiName": "api",
        "type": 1,
        "status": 1,
        "regex": null,
        "sysEntityIdentifier": null,
        "remark": "描述",
        "orders": null,
        "valueList": null
    },
    "extra": null
}

实体-获取列表接口

请求地址

请求参数

Request parameters

Parameter Type Optional Description
robotId Integer false 机器ID.
pageNum Integer true 页码 (默认为1).
pageSize Integer true 每页数量 (默认为10,最大为100).
keyword Integer true 关键字.
status Integer true 实体启用状态 0:禁用 1:启用.

请求结果

Path Type Optional Description
code Integer true 状态码
message String true 返回信息
visible Boolean true
data Object true 返回内容

示例

$ curl 'https://km.udesk.cn/api/v1/entity/robot/83?pageNum=1&pageSize=15&keyword="实体名称"&status=1&&email=admin@udesk.cn&timestamp=1559022283&sign=aa8164470dff8468e6129c1e7d5767651cdedd7c' -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json'
返回
{
    "code": 200,
    "message": "OK",
    "visible": false,
    "exception": null,
    "paging": null,
    "data": {
        "id": 2850,
        "robotId": 83,
        "name": "实体名称",
        "apiName": "api",
        "type": 1,
        "status": 1,
        "regex": null,
        "sysEntityIdentifier": null,
        "remark": "描述",
        "orders": null,
        "valueList": null
    },
    "extra": null
}