获取客服组列表

该接口用于一次获取多个客服组信息

请求方法

GET /user_groups

请求参数（Query String）

参数名 必填 类型 说明 限制
page 否 整型 页码，从1开始，默认为1
per_page 否 整型 每页数量，默认20，最大100

返回数据

属性名 类型 说明
code 整型 执行结果码，1000代表成功
meta 对象 分页信息，详见通用数据
user_groups 数组 客服组列表，每个客服组的说明参见下文

客服组数据

属性名 类型 说明
id 整型 唯一标识
name 字符串 名称
agents 数组 包含客服

agents元素结构

取值 含义
id 客服唯一标识
nick_name 客服姓名

示例

curl https://demo.udesk.cn/open_api_v1/user_groups?page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

返回

{
    "code": 1000,
    "user_groups": [
        {
            "id": 1,
            "name": "客服组1",
            "agents": [
                {"id": 1, "nick_name": "测试客服1"}
            ]
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1
    }
}

获取客服组下客服

该接口用于一次获取多个客服组信息

请求方法

GET /user_groups/:id/agents

请求参数（Query String）

参数名 必填 类型 说明 限制
page 否 整型 页码，从1开始，默认为1
per_page 否 整型 每页数量，默认20，最大100

返回数据

属性名 类型 说明
code 整型 执行结果码，1000代表成功
user_group 对象 客服组详情

客服组数据

属性名 类型 说明
id 整型 唯一标识
name 字符串 名称
agents 数组 包含客服

agents元素结构

取值 含义
id 客服唯一标识
nick_name 客服姓名
email 客服邮箱
cellphone 客服手机
work_id 工号
im_ability_value 对话技能值
profile 员工类型
aliase 外显昵称
role_name 账号类型
duty 员工职务
user_group_ids 所属客服组id列表
disable_status 状态 (enable: 启用, disable: 禁用)
avatar 头像
lang 语言偏好
availability 是否接受自动工单分配
im_welcomes 欢迎语言
user_groups 所属员工组
agent_roles 员工所属角色
departments 所属部门
agent_callout_display_number 外呼显号
number SIP信息
password SIP信息

示例

curl http://demo.udesk.cn/open_api_v1/user_groups/1/agents?page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

返回

{
    "code": 1000,
    "user_groups": [
        {
            "id": 1,
            "name": "客服组1",
            "agents": [
                {
                    "id": 1,
                    "nick_name": "测试客服1",
                    "cellphone": 12345678901,
                    "work_id": 1,
                    "profile": "all",
                    "aliase": "测试客服1",
                    "role_name": "agent",
                    "duty": null,
                    "user_group_ids": [1],
                    "im_ability_value": 10,
                    "disable_status": "enable",
                    "avatar": "http://attachments.gfan.com/forum/attachments2/201302/03/11281446n2st1its4152n5.jpg",
                    "lang": "en-us",
                    "availability": true,
                    "im_welcomes": "",
                    "user_groups": [
                        {"id":2,"name":"客服组1"}
                    ],
                    "agent_roles": [
                        {"id": 1, "name": "角色1", "description": ""}
                    ],
                    "departments": [
                        {"id":1,"name":"部门1"},
                        {"id":3,"name":"部门3"}
                    ],
                    "agent_callout_display_number": "",
                    "number": "",
                    "password": "",
                }
            ]
        }
    ]
}

创建客服组

该接口用于创建客服组

请求方法

POST /user_groups

请求参数(request body)

参数 必填 类型 说明 限制 默认
name 是 字符串 客服组名称 不超过255个字符

返回数据

属性名 类型 说明
code 整型 执行结果码，1000代表成功
id 整型 创建客服组id

示例

请求

curl https://demo.udesk.cn/open_api_v1/user_groups?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type:application/json' \
-d '{
"name":"客服组1"
}'

返回

{
    "id": 1,
    "code": 1000
}

修改客服组

该接口用于修改客服组

请求方法

PUT /user_groups/:id

请求参数(request body)

参数 必填 类型 说明 限制 默认
name 是 字符串 客服组名称 不超过255个字符

返回数据

属性名 类型 说明
id 整型 本次操作修改的客服组id
code 整型 执行结果码，1000代表成功
user_group 对象 客服组信息，结构如下

user_group的结构

属性名 类型 说明
id 整型 唯一标识
name 字符串 名称
agents 数组 包含客服

示例

请求

curl https://demo.udesk.cn/open_api_v1/user_groups/1?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type:application/json' \
-d '{
"name":"客服组2"
}'

返回

{
    "code": 1000,
    "user_group": {
      "id": 1,
      "name": "客服组2",
      "agents": [
                {"id": 1, "nick_name": "测试客服1"},
                {"id": 2, "nick_name": "测试客服2"}
            ]
    }
}

删除客服组

该接口用于删除客服组

请求方法

DELETE /user_groups/:id

请求参数(url)

参数名 类型 必填 说明 限制
id 整型 是 客服组id

请求参数(request body)

无

返回数据

属性名 类型 说明
code 整型 执行结果码，1000代表成功
message 字符串 执行结果说明

示例

请求

curl https://demo.udesk.cn/open_api_v1/user_groups/1?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
-X DELETE \
-H 'content-type: application/json' \

返回

{
    "message": "id为1的客服组删除成功",
    "code": 1000
}

code错误码说明

错误码 message信息 exception:message信息 描述
2000 未知错误 验证失败: 组名不能为空字符 必填参数name不能为空
name不可为空 无 参数name的值不能为空
2005 没有找到该资源 Couldn't find UserGroup with id=xxx [WHERE user_groups.company_id
= ? AND user_groups.category = '普通客服组']		 参数id没有匹配到值