获取客服组列表

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

请求方法

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=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

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

获取客服组下客服

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

请求方法

GET /user_groups/:id/agents

请求参数(Query String)

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

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
meta 对象 分页信息,详见通用数据
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=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1 
    },
    "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=1503298812&sign=4a38e71a044e4dccb6069418abd2153e905a31cb \
-X POST \
-H 'content-type: appliacation/json' \
-d '{"name": "客服组1"}'

返回

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

修改客服组

该接口用于修改客服组

请求方法

PUT /user_groups/:id

请求参数(request body)

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

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
user_group 对象 客服组信息,结构如下

user_group的结构

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

示例

请求

curl https://demo.udesk.cn/open_api_v1/user_groups?email=admin@udesk.cn&timestamp=1503298812&sign=4a38e71a044e4dccb6069418abd2153e905a31cb \
-X POST \
-H 'content-type: appliacation/json' \
-d '{"name": "客服组2"}'

返回

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

删除客服组

该接口用于删除客服组

请求方法

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=1503298812&sign=4a38e71a044e4dccb6069418abd2153e905a31cb \
-X DELETE \
-H 'content-type: application/json' \

返回

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