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 是 座席状态变更原因
点击查看详情
“agent logout”：坐席签出
“monitor logout”：坐席签出
“agent setup” ：坐席设置
“call answer”：通话中
“call end”：呼叫结束
“auto set”：会话后超时
“incoming call”：来电中
“call out” ：外呼中
“remote loginout” ： 远程签入签出
“force_LockToReady”  ：呼叫分配中
“monitor setup”：坐席设置
“auto_start”：会话后处理中
24 password String 是 座席密码
25 is_auto_ready Number 是 是否自动应答 1-是 0-否
26 auto_ready_interval Number 是 自动应答等待时间 单位秒

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": "cdf8146xxxxxfab9f7837ee7ea8a7b",
    "agent_name": "王二狗",
    "agent_num": "1003",
    "status": 1,
    "mobile": "181xxxx7509",
    "mail": "xxxxx@uincall.com",
    "nickname": "1003",
    "dept_id": "b4f44877xxxxx06fed6cffd9651e044",
    "dept_name": "后端",
    "role_id": "74dd71dcfxxxxx51c75d5c64d3cc170",
    "role_names": "管理员",
    "explicit_number_type": 1,
    "service_number": "02xxxxx3191",
    "number_pool_id": "e7f39xxxxxeac06073af85f3349a650",
    "number_pool_name": "随机外显",
    "is_login": true,
    "change_time": "2024-08-26 14:12:41",
    "state_to": "busy",
    "state_from": "offline",
    "reason": "agent setup"
    }
  ]
}
文档更新时间: 2025-01-15 09:48   作者：admin