FAQ知识库分类接口

获取FAQ分类列表

请求地址

请求参数

Query parameters

Parameter Type Optional Description
robotId int false 机器人ID.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Array true
data[].id Integer true ID.
data[].name String true 名称.
data[].parentId Integer true 父ID.
data[].parentIds String true 父ID路径,逗号分隔.
data[].robotId Integer true 机器人ID.

示例

$ curl 'https://km.udesk.cn/api/v1/categories?email=admin@udesk.cn&timestamp=1529402433&sign=e4f683120c26df279b3642ac77b0bd8bf621584a&robotId=102' -i -H 'Accept: application/json'
返回
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : [ {
    "id" : 406,
    "name" : "分类2",
    "parentId" : 342,
    "parentIds" : "0,342,",
    "robotId" : 102
  }, {
    "id" : 342,
    "name" : "全部",
    "parentId" : 0,
    "parentIds" : "0,",
    "robotId" : 102
  }, {
    "id" : 343,
    "name" : "未分类",
    "parentId" : 342,
    "parentIds" : "0,342,",
    "robotId" : 102
  } ]
}

获取FAQ知识库分类详情

请求地址

请求参数

Path parameters

Parameter Type Optional Description
id int false ID.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Object true
data.id Integer true ID.
data.name String true 名称.
data.parentId Integer true 父ID.
data.parentIds String true 父ID路径,逗号分隔.
data.robotId Integer true 机器人ID.

示例

$ curl 'https://km.udesk.cn/api/v1/categories/403?email=admin@udesk.cn&timestamp=1529402429&sign=c8b3e4dfef80a80e6125d2863912f6cdf1d20509' -i -H 'Accept: application/json'
返回
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 403,
    "name" : "分类2",
    "parentId" : 342,
    "parentIds" : "0,342,",
    "robotId" : 102
  }
}

删除FAQ知识库分类

请求地址

请求参数

Path parameters

Parameter Type Optional Description
id int false ID.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data null true

示例

$ curl 'https://km.udesk.cn/api/v1/categories/379?email=admin@udesk.cn&timestamp=1529402432&sign=67df1ddd1aad415933d63da93ca24b59c8970740' -i -X DELETE -H 'Content-Type: application/json'
返回
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : null
}

新建FAQ知识库分类

请求地址

请求参数

Request fields

Parameter Type Optional Description
name String false 名称.
parentId Integer false 父级ID.
robotId Integer false 机器人ID.

请求结果

Path Type Optional Description
code Integer true
message String true
visible Boolean true
data Object true
data.id Integer true ID.
data.name String true 名称.
data.parentId Integer true 父ID.
data.parentIds String true 父ID路径,逗号分隔.
data.robotId Integer true 机器人ID.

示例

$ curl 'https://km.udesk.cn/api/v1/categories?email=admin@udesk.cn&timestamp=1529402431&sign=bd23cf273d088d9c9031958712670673dae1d5ce' -i -X POST -H 'Content-Type: application/json' -d '{
  "name" : "分类2",
  "parentId" : 342,
  "robotId" : 102
}'
返回
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 404,
    "name" : "分类2",
    "parentId" : 342,
    "parentIds" : "0,342,",
    "robotId" : 102
  }
}