1.1 接口说明

在优音云客服系统中,可通过座席工号来查询座席信息。

1.2 调用形式

https://ykf.uincall.com/openapi/communication/agents/data?tenant_id=acf528a2-xxxx-xxxx-8513-74cb3995cfab&access_token=afa7752035dxxxxxxeef46e04e4b4d10

1.3 调用方式

POST

1.4 传入参数

序号 名称 类型 是否必填 说明
1 agent_nums List 座席编号,当集合为空时表示查询当前租户下全部座席数据

1.5 回应参数

序号 名称 类型 是否必填 说明
1 errcode Number 状态码:0成功,及其他非0错误码,详见错误码列表
2 errmsg String 状态说明
3 data Object数组 结果集(有数据时返回Object)
4 agent_id String 座席ID
5 agent_num String 座席编号
6 agent_name String 座席名称
7 status String 0-禁用;1-启用;
8 mobile String 座席手机号
9 mail String 座席邮箱
10 nickname String 座席昵称
11 dept_id String 座席所属部门ID
12 dept_name String 部门名称
13 role_id String 座席所属角色ID
14 role_names String 座席所属角色名称
15 explicit_number_type Number 座席外呼类型,1:外显号码 2:号码池
16 service_number String 外显号码
17 number_pool_id String 号码池ID
18 number_pool_name String 号码池名称
19 is_login Boolean 座席是否在线
20 change_time String 座席状态变更时间
21 state_to String 座席当前状态
22 state_from String 座席之前状态
23 reason String 座席状态变更原因

1.6 使用样例

调用:

url:https://ykf.uincall.com/openapi/communication/agents/data?tenant_id=acf528a2-dxxxx-4a7b-8513-74cb3995cfab&access_token=afa7752035d916xxxeef46e04e4b4d10

{
"agent_nums":["1003"]
}

响应:

{
"errcode": 0,
"errmsg": "success",
"data": [
    {
        "agent_id": "cdf8146f0270f0fab9f7837ee7ea8a7b",
        "agent_name": "王二狗",
        "agent_num": "1003",
        "status": 1,
        "mobile": "18165287509",
        "mail": "guohaoyi@uincall.com",
        "nickname": "1003",
        "dept_id": "b4f448774c1bca06fed6cffd9651e044",
        "dept_name": "后端",
        "role_id": "74dd71dcf4c1d9d51c75d5c64d3cc170",
        "role_names": "管理员",
        "explicit_number_type": 1,
        "service_number": "02566823191",
        "number_pool_id": "e7f3960355beac06073af85f3349a650",
        "number_pool_name": "随机外显",
        "is_login": true,
        "change_time": "2024-08-26 14:12:41",
        "state_to": "busy",
        "state_from": "offline",
        "reason": "agent setup"
    }
  ]
}
文档更新时间: 2024-08-29 15:07   作者:admin