知识库分类接口

knowledge_type 的取值

中文名称 英文名称
问题 question
常用语 useful_expression   
常用链接 useful_link  
附件 attachment

新建不同知识库类型分类

该接口用于创建不同类型知识库的分类

请求方法

POST /knowledge_catalogs

请求参数(Request Body)

参数名 类型 必填 说明 限制
knowledge_catalog 对象 知识库的参数  

knowledge_catalog的结构如下:

参数名 类型 必填 说明 限制
name 字符串 知识库的名称 不超过255个字符
knowledge_type_name 字符串 使用knowledge_type的英文名称 
parent_id 整型 上一级的分类id
agent_id 整型 是   客服id
说明:

返回数据

属性名 类型 说明   
code    整型 执行结果码,1000代表成功
name 字符串 新建分类的名称
id 整型 新建分类的id

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_catalogs?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type: appliacation/json' \
-d '
{
    "knowledge_catalog": {
        "knowledge_type_name": "question",
        "name": "问题库1",
        "agent_id":0,
        "parent_id": ""
    }
}
'

结果

{
    "code": 1000,
    "id": 22,
    "name": "问题库1"
}

修改不同知识库类型的分类

该接口用于修改已有的不同类型知识库的分类

请求方法

PUT /knowledge_catalogs/:id

请求参数(URL)

参数名 类型 必填 说明 限制
id 整型 分类的id

请求参数(Request Body)

参数名 类型 必填 说明 限制
knowledge_catalog 对象 知识库的参数  

knowledge_catalog的结构如下:

参数名 类型 必填 说明 限制
name 字符串 知识库的名称 不超过255个字符
agent_id 整型 客服id
说明:

返回数据

属性名 类型 说明
code    整型 执行结果码,1000代表成功
name 字符串 新建分类的名称
id      整型      新建分类的id

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_catalogs/11?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
-X PUT \
-H 'content-type: appliacation/json' \
-d '
{
    "knowledge_catalog": {
        "name": "常用链接",
        "agent_id": 0
    }
}
'

结果

{
    "code": 1000,
    "id": 11,
    "name": "常用链接"
}

删除不同知识库类型的分类

该接口用于删除已有的不同类型知识库的分类

请求方法

DELETE /knowledge_catalogs/:id

请求参数(Url)

参数名 类型 必填 说明 限制
id 整型 分类的id

请求参数(Request Body)

参数名 类型 必填 说明 限制
knowledge_catalog 对象 知识库的参数  

knowledge_catalog的结构如下:

参数名 类型 必填 说明 限制
agent_id 整型 客服id
说明:

返回数据

属性名 类型 说明
code    整型 执行结果码,1000代表成功
id 整型 删除的分类id           
message 字符串 删除分类的信息

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_catalogs/19?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: appliacation/json' \
-d '
{
    "knowledge_catalog": {
        "agent_id":"0"
    }
}
'

结果

{
    "code": 1000,
    "message": "分类删除成功",
    "id": "19"
}

获取不同知识库类型的分类列表

该接口用于获取已有的不同类型知识库的分类列表

请求方法

GET /knowledge_catalogs

请求参数(Request Body)

参数名 类型 必填 说明 限制
knowledge_type_name 字符串 使用knowledge_type的英文名称 
agent_id 整型 客服id,默认为管理员
说明:

返回数据

属性名 类型 说明
code    整型 执行结果码,1000代表成功
catalogs 数组      分类列表               

catalogs 的结构如下:

属性名 类型 说明
name 字符串 分类的名称
id      整型      分类的id
parent_id  整型      分类的上一级id,parent_id=0时表示其为一级分类
children 对象  分类的子分类

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_catalogs?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&knowledge_type_name=useful_expression&agent_id=0

结果

{
    "code": 1000,
    "catalogs": [
        {
            "id": 4,
            "parent_id": 0,
            "name": "常用语1"
        },
        {
            "id": 5,
            "parent_id": 0,
            "name": "常用语2",
            "children": [
                {
                    "id": 6,
                    "parent_id": 5,
                    "name": "常用语1-1"
                }
            ]
        }
    ]
}

常用语接口

获取常用语列表

该接口用于获取某个客服下全部或指定分类下的常用语

请求方法

GET /useful_expressions

请求参数(Query String)

参数名 类型 必填 说明 限制
catalog_id 整型 常用语分类id
agent_id 整型 常用语分类所属者的id
page 整型 否     页码,从1开始,默认为1
per_page 整型 每页数量,默认20,最大100
说明:

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
useful_expressions 数组 常用语列表
meta 对象      分页相关内容,参见通用数据

useful_expressions 的数据结构

属性名 类型 说明
id 整型 常用语id
content 字符串 常用语内容
catalog_id 整型 常用语分类id

示例

请求

curl https://demo.udesk.cn/open_api_v1/useful_expressions?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&catalog_id=15&agent_id=12

返回

{
    "code": 1000,
    "useful_expressions": [
        {
            "id": 1,
            "content": "content1",
            "catalog_id": 4
        },
        {
            "id": 2,
            "content": "content2",
            "catalog_id": 5
        },
        {
            "id": 3,
            "content": "content2",
            "catalog_id": 6
        },
        {
            "id": 4,
            "content": "content4",
            "catalog_id": 6
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 4
    }
}

更新常用语

该接口用于修改某一具体的常用语内容

请求方法

PUT /useful_expressions/:id

请求参数(URL)

参数名 类型 必填 说明 限制
id 整型 常用语id

请求参数(Request Body)

参数名 类型 必填 说明 限制
content 字符串 常用语内容
agent_id 整型 常用语创建者的id
说明:

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
id 整型 常用语id       
content 字符串 常用语内容         

示例

请求

curl https://demo.udesk.cn/open_api_v1/useful_expressions/4?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type: appliacation/json' \
-d '
{
  "content": "content12",
  "agent_id": 0
}
'

返回

{
    "code": 1000,
    "id": 4,
    "content": "content12",
    "catalog_id": 6
}

增加常用语

该接口用于在某一个客服的某一个常用语分类下新建一条常用语

请求方法

POST /useful_expressions

请求参数(Request Body)

参数名 类型 必填 说明 限制
content 字符串 常用语内容
catalog_id 整型 常用语分类id
agent_id 整型 常用语创建者的id
说明:

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
id 整型 常用语id
content 字符串 常用语内容
catalog_id 整型 常用语分类id

示例

请求

curl https://demo.udesk.cn/open_api_v1/useful_expressions?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type: appliacation/json' \
-d '
{
  "content": "kakkakakakakakakaka",
  "agent_id": 0,
  "catalog_id": 6
}
'

返回

{
    "code": 1000,
    "id": 4,
    "content": "kakkakakakakakakaka",
    "catalog_id": 6
}

删除常用语

该接口用于删除某一具体的常用语

请求方法

DELETE /useful_expressions/:id

请求参数(URL)

参数名 类型 必填 说明 限制
id 整型 常用语id

请求参数(Request Body)

参数名 类型 必填 说明 限制
agent_id 整型 常用语创建者的id

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
id 整型 常用语id
message 字符串 结果说明

示例

请求

curl https://demo.udesk.cn/open_api_v1/useful_expressions/4?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: appliacation/json' \
-d '
{
  "agent_id": 0
}
'

返回

{
    "code": 1000,
    "message": "常用语删除成功",
    "id": "4"
}

常用链接接口

获取常用链接列表

该接口用于获取某个客服下全部或指定分类下的常用链接

请求方法

GET /useful_links

请求参数(Query String)

参数名 类型 必填 说明 限制
catalog_id 整型 常用链接分类id
agent_id 整型 常用链接分类所属者的id
page 整型 否     页码,从1开始,默认为1
per_page 整型 每页数量,默认20,最大100
说明:

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
useful_links 数组 常用链接列表
meta 对象      分页相关内容,参见通用数据

useful_links 的数据结构

属性名 类型 说明
id 整型 常用链接id
name 字符串 常用链接名称
url 字符串 常用链接地址
catalog_id 整型 常用链接分类id

示例

请求

curl https://demo.udesk.cn/open_api_v1/useful_links?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&catalog_id=15&agent_id=12

返回

{
    "code": 1000,
    "useful_links": [
        {
            "id": 6,
            "name": "链接6",
            "url": "https://www.baidu1.com",
            "catalog_id": 11
        },
        {
            "id": 8,
            "name": "链接8",
            "url": "https://www.baidu1.com",
            "catalog_id": 11
        },
        {
            "id": 9,
            "name": "链接9",
            "url": "https://www.baidu1.com",
            "catalog_id": 11
        },
        {
            "id": 10,
            "name": "链接10",
            "url": "https://www.baidu1.com",
            "catalog_id": 11
        },
        {
            "id": 11,
            "name": "链接11",
            "url": "https://www.baidu1.com",
            "catalog_id": 11
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 5
    }
}

更新常用链接

该接口用于修改某一具体的常用链接

请求方法

PUT /useful_links/:id

请求参数(URL)

参数名 类型 必填 说明 限制
id 整型 常用链接id

请求参数(Request Body)

参数名 类型 必填 说明 限制
name 字符串 常用链接内容
url  字符串 常用链接地址
agent_id 整型 常用链接创建者的id
说明:

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
id 整型 常用链接id     
name 字符串 常用链接名称        
url 字符串 常用链接地址        
catalog_id 整型 常用链接分类id

示例

请求

curl https://demo.udesk.cn/open_api_v1/useful_links/12?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type: appliacation/json' \
-d '
{
  "name": "",
  "url": "https://www.bai.com",
  "agent_id": 4
}'

返回

{
    "code": 1000,
    "id": 12,
    "name": "name",
    "url": "https://www.bai.com",
    "catalog_id": 12
}

增加常用链接

该接口用于在某一个客服的某一个常用链接分类下新建一条常用链接

请求方法

POST /useful_links

请求参数(Request Body)

参数名 类型 必填 说明 限制
name    字符串 常用链接名称
url     字符串 常用链接地址
catalog_id 整型 常用链接分类id
agent_id 整型 常用链接创建者的id
说明:

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
id 整型 常用链接id

示例

请求

curl https://demo.udesk.cn/open_api_v1/useful_expressions?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type: appliacation/json' \
-d '
{
  "name": "链接10",
  "url": "https://www.baidu1.com",
  "catalog_id": 12,
  "agent_id": 4
}
'

返回

{
    "code": 1000,
    "id": 12,
    "name": "链接10",
    "url": "https://www.baidu1.com",
    "catalog_id": 12
}

删除常用链接

该接口用于删除某一具体的常用链接

请求方法

DELETE /useful_links/:id

请求参数(URL)

参数名 类型 必填 说明 限制
id 整型 常用链接id

请求参数(Request Body)

参数名 类型 必填 说明 限制
agent_id 整型 常用链接创建者的id

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
id 整型 常用链接id
message 字符串 结果说明

示例

请求

curl https://demo.udesk.cn/open_api_v1/useful_expressions/7?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: appliacation/json' \
-d '
{
  "agent_id": 4
}
'

返回

{
    "code": 1000,
    "id": "7",
    "message": "常用链接删除成功"
}

问题库接口

获取问题库问题列表

该接口用于获取某个客服下全部或指定分类下的问题库问题列表

请求方法

GET /knowledge_questions

请求参数(Query String)

参数名 类型 必填 说明 限制
catalog_id 整型 问题库分类id
agent_id 整型 问题库分类所属者的id
page 整型 否     页码,从1开始,默认为1
per_page 整型 每页数量,默认20,最大100
说明:

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
knowledge_questions 数组 问题库问题列表
meta 对象      分页相关内容,参见通用数据

knowledge_questions 的数据结构

属性名 类型 说明
id 整型 问题库问题id
title 字符串 问题库问题名称
content 字符串 问题库问题答案
content_type 字符串 问题库问题答案类型
catalog_id 整型 问题库分类id
updated_at 日期时间 问题库问题最后更新时间
lasts    布尔   问题库问题是否永久有效
last_min    日期时间 问题库问题时效下限
last_max    日期时间 问题库问题时效上限

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_questions?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&catalog_id=0&agent_id=0

返回

{
    "code": 1000,
    "knowledge_questions": [
        {
            "id": 1,
            "title": "问题1",
            "content": "啊啊啊啊",
            "content_type": "text",
            "lasts": true,
            "catalog_id": null,
            "updated_at": "2018-03-22T11:29:59.000+08:00",
            "last_min": null,
            "last_max": null
        },
        {
            "id": 3,
            "title": "水水水水",
            "content": "水水水水",
            "content_type": "text",
            "lasts": true,
            "catalog_id": 17,
            "updated_at": "2018-03-22T18:35:02.000+08:00",
            "last_min": "2018-03-31",
            "last_max": "2018-04-03"
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 2
    }
}

更新问题库

该接口用于修改某一具体的问题库问题

请求方法

PUT /knowledge_questions/:id

请求参数(URL)

参数名 类型 必填 说明 限制
id 整型 问题库问题id

请求参数(Request Body)

参数名 类型 必填 说明 限制
question 对象 问题的具体值 

question的数据结构

参数名 类型 必填 说明 限制
agent_id 整型 问题的创建者的id
content 字符串 问题的答案
title 字符串 问题的名称
content_type 字符串 问题的答案类型
lasts 布尔 问题是否永久有效
last_min 日期时间 问题的时效下限
last_max 日期时间 问题的时效上限
说明:

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
id 整型 问题库id       
title 字符串 问题库问题         
content_type 字符串   问题库问题内容类型  
content 字符串 问题库内容内容      
lasts    布尔   问题库问题是否永久有效
last_min    日期时间 问题库问题时效下限
last_max    日期时间 问题库问题时效上限

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_questions/8?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type: appliacation/json' \
-d '
{
    "question": {
        "agent_id": 0,
        "content": "asasasaasasadasass",
        "title": "",
        "content_type": "",
        "lasts": false,
        "last_min": "2018-03-31",
        "last_max": "2018-04-03"
    }
}
'

返回

{
    "code": 1000,
    "id": 8,
    "title": "title5",
    "content": "asasasaasasadasass",
    "content_type": "html",
    "catalog_id": null,
    "lasts": false,
    "last_min": "2018-03-31",
    "last_max": "2018-04-03"

}

增加问题库

该接口用于在某一个客服的某一个问题库分类下新建一条问题库问题

请求方法

POST /knowledge_questions

请求参数(Request Body)

参数名 类型 必填 说明 限制
question 对象 问题的具体值 

question的数据结构

参数名 类型 必填 说明 限制
agent_id 整型 问题的创建者的id
content 字符串 问题的答案
title 字符串 问题的名称
content_type 字符串 问题的答案类型
catalog_id 整型 问题库分类id
lasts 布尔 问题库问题是否永久有效
last_min 日期时间 问题库问题时效下限
last_max 日期时间 问题库问题时效上限
说明:

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
id 整型 问题库id

示例

请求

curl https://demo.udesk.cn/open_api_v1/useful_expressions?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type: appliacation/json' \
-d '
{
    "question": {
        "agent_id": 0,
        "content": "asasasas",
        "title": "title1",
        "content_type": "html",
        "catalog_id":0,
        "lasts": true
    }
}
'

返回

{
    "code": 1000,
    "id": 8,
    "title": "title5",
    "content": "asasasas",
    "content_type": "html",
    "catalog_id": null,
    "lasts": true,
    "last_min": null,
    "last_max": null
}

删除问题库

该接口用于删除某一具体的问题库问题

请求方法

DELETE /knowledge_questions/:id

请求参数(URL)

参数名 类型 必填 说明 限制
id 整型 问题库问题id

请求参数(Request Body)

参数名 类型 必填 说明 限制
agent_id 整型 问题库问题创建者的id

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
id 整型 问题库id

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_questions/8?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: appliacation/json' \
-d '
{
  "agent_id": 0
}
'

返回

{
    "code": 1000,
    "id": "8",
    "message": "问题删除成功"
}

附件库接口

获取附件库附件列表

该接口用于获取某个客服下全部或指定分类下的附件列表

请求方法

GET /knowledge_attachments

请求参数(Query String)

参数名 类型 必填 说明 限制
catalog_id 整型 常用链接分类id
agent_id 整型 常用链接分类所属者的id
page 整型 否     页码,从1开始,默认为1
per_page 整型 每页数量,默认20,最大100
说明:

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
knowledge_attachments 数组 附件列表
meta 对象      分页相关内容,参见通用数据

knowledge_attachments 的数据结构

属性名 类型 说明
id 整型 附件id     
file_name 字符串 附件名称     
file_type 字符串 附件类型     
file_size 字符串 附件大小     
file_url 字符串 附件地址     
catalog_id 整型 附件所在分类id

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_attachments?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&catalog_id=0&agent_id=0

返回

{
    "code": 1000,
    "knowledge_attachments": [
        {
            "id": 1,
            "catalog_id": 9,
            "file_name": "JPG.JPG",
            "file_type": "image/jpeg",
            "file_size": null,
            "file_url": "https://qn-public.udesk.cn/1472632419-JPG.JPG"
        },
        {
            "id": 2,
            "catalog_id": 10,
            "file_name": "JPG.JPG",
            "file_type": "image/jpeg",
            "file_size": null,
            "file_url": "https://qn-public.udesk.cn/JPG.JPG"
        },
        {
            "id": 3,
            "catalog_id": null,
            "file_name": "jira任务记录.docx",
            "file_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "file_size": "11858",
            "file_url": "https://qn-public.udesk.cn/Fs65I3NAYnqt_URMYQB8NAwerWI3"
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 3
    }
}

重新上传附件

该接口用于修改某一具体的附件

请求方法

PUT /knowledge_attachments/:id

请求参数(URL)

参数名 类型 必填 说明     限制
id 整型 常用链接id
file_name 字符串 附件文件
type 字符串 附件文件类型
agent_id 整型 附件创建者的id
说明:

返回数据

属性名 类型 说明
id 整型 附件id     
file_name 字符串 附件名称     
file_type 字符串 附件类型     
file_size 字符串 附件大小     
file_url 字符串 附件地址     
catalog_id 整型 附件所在分类id

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_attachments?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&file_name=aaa&type=jpg&agent_id=0&catalog_id=10 \
-X PUT \
-H 'content-type: appliacation/json' \
-d '
'

返回

{
    "code": 1000,
    "id": 5,
    "catalog_id": 10,
    "file_name": "9747.jpg_wh300.jpg",
    "file_type": "jpg",
    "file_size": 79044,
    "file_url": "https://qn-public.udesk.cn/Fk8NQDfDUqbImbZvD37VVDejCNfv"
}

新建附件

该接口用于在某一个客服的某一个附件分类下新建附件

请求方法

POST /knowledge_attachments

请求参数(Request Url)

参数名 类型 必填 说明 限制
file_name 字符串  附件名称         
type 字符串  附件文件类型     
catalog_id 整型 附件分类id     
agent_id 整型 附件创建者的id    
说明:

返回数据

属性名 类型 说明
id 整型 附件id     
file_name 字符串 附件名称     
file_type 字符串 附件类型     
file_size 字符串 附件大小     
file_url 字符串 附件地址     
catalog_id 整型 附件所在分类id

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_attachments?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&file_name=aaa&type=jpg&agent_id=0&catalog_id=10 \
-X POST \
-H 'content-type: appliacation/json' \
-d '
'

返回

{
    "code": 1000,
    "id": 4,
    "catalog_id": 10,
    "file_name": "9747.jpg_wh300.jpg",
    "file_type": "jpg",
    "file_size": 79044,
    "file_url": "https://qn-public.udesk.cn/Fk8NQDfDUqbImbZvD37VVDejCNfv"
}

删除附件

该接口用于删除某一具体的附件

请求方法

DELETE /knowledge_attachments/:id

请求参数(URL)

参数名 类型 必填 说明 限制
id 整型 常用链接id
agent_id 整型 常用链接创建者的id

返回数据

属性名 类型 说明   
code 整型 执行结果码,1000代表成功
id 整型 常用链接id
message 字符串 结果说明

示例

请求

curl https://demo.udesk.cn/open_api_v1/knowledge_attachments/4111?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE \
-H 'content-type: appliacation/json' \
-d '
{
  "agent_id": 12
}
'

返回

{
    "code": 1000,
    "id": "4111",
    "message": "附件删除成功"
}

code错误码说明

错误码 message信息 exception:message信息 描述
2000 agent_id是必填项 参数中agent_id未填写
agent_id是整型 agent_id是非整型参数
该分类不存在 没有id是{catelog_id}的分类
该客服名下不存在该分类 id是{catelog_id}的分类不属于id是{agent_id}的客服,无法修改
catalog_id是必填项 参数中{catelog_id}不能为空
catalog_id是整型 参数中{catelog_id}的值必须为整型
未找到资源 没有找到对应id的数据
该客服名下不存在该链接分类 id是{catelog_id}的常用链接分类不属于id是{agent_id}的客服
未知错误
knowledge_type_name的值不对 参数{knowledge_type_name}的值错误
验证失败: 名称不能为空字符 参数{name}的值不能为空
验证失败: Parent不属于同一分类 在{knowledge_type_name}类型下找不到id是{parent_id}的分类
父级分类下存在内容,无法创建分类 id是{parent_id}的分类非叶子节点(有其他数据)
最多可建四级分类 id是{parent_id}的分类是第四级分类(知识库分类的层级最多允许4级)
验证失败: 名称已被占用 id是{parent_id}的分类下有和{name}同名的子类
管理员的已有分类下不存在id为{parent_id}的分类 id是{parent_id}的分类不存在
param is missing or the value is empty: knowledge_catalog 参数中缺少对象{knowledge_catalog}
常用语内容content不可为空 参数中content的值不能为空
您没有设置修改内容 修改常用链接时,参数中name或url至少有一个有值
常用链接名称name是必填项 参数中name值不能为空
常用链接地址url是必填项 参数中url值不能为空
param is missing or the value is empty: question 参数中缺少question对象
content_type的值不对 参数content_type的值只能是text、html
问题有效期lasts不可为空 参数lasts的值不能为空,必须是true/false
last_min格式不对 当参数lasts值是false时,参数last_min的值必须遵循日期格式且不能为空
last_max格式不对 当参数lasts值是false时,参数last_max的值必须遵循日期格式且不能为空
last_max不可小于等于last_min 当参数lasts值是false时,参数last_max的值必须小于等于参数last_min的值
content不可为空 参数content的值不能为空
title不可为空 参数title的值不能为空
content_type不可为空 参数content_type的值不能为空
问题有效期lasts的值不对 参数lasts的值不能为空,必须是true/false
问题有效期的时间上限和时间下限不可为空 参数last_min、last_max的值不能为空
file_name是必填项,且不可为空 参数file_name的值不能为空
type是必填项,且不可为空 参数type的值不能为空
2005 没有找到该资源 ActiveRecord::RecordNotFound 参数{id}未匹配到数据