查询指定VDN下的座席电话号码
场景描述
查询指定VDN下的所有座席电话号码
接口方法
设置成“POST”。该接口仅支持POST方法,不支持PUT、GET和DELETE等方法。
内部封装接口
BMS接口:/ccbms/ws/monitor/siteagentinfobyagentids
请求URL
https://ip:port/rest/cmsapp/v1/openapi/vdn/allagentphones
其中,公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。
非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
Content-Type |
String |
True |
固定填 application/json; charset=UTF-8。 |
2 |
Authorization |
String |
True |
生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
ccId |
int |
True |
呼叫中心编号。 取值范围:1~65535 |
2 |
vdn |
int |
True |
虚拟呼叫中心编号。 取值范围:1~5000 |
3 |
limit |
int |
True |
表示每页的查询数量。 取值范围:1~1000 |
4 |
offset |
int |
True |
offset用于确定查询的起始页 offset取值公式为:offset=limit*(page-1),取值范围:>=0。 page为需要查询的起始页。 |
响应说明
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
result |
String |
查询结果。取值如下:
失败的原因说明请参见错误码参考。
说明:
当前字段为兼容8.13及其之前版本接口响应参数使用。 |
1 |
resultCode |
string |
查询结果。取值如下:
|
3 |
resultDatas |
array |
查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。
说明:
当前字段为兼容8.13及其之前版本接口响应参数使用。 |
2 |
resultDesc |
array |
查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4 |
3 |
count |
int |
当前查询VDN下座席总数。 |
报文样例
- 请求头:
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- 请求参数:
{ "ccId":1, "vdn":170, "offset":0, "limit":4 }
- 响应参数
{ "result": "0", "resultCode": "0100000", "count": 30, "resultDatas": [ { "agentId": 55002, "phone": 620001 }, { "agentId": 833, "phone": 620002 }, { "agentId": 834, "phone": 620003 }, { "agentId": 835, "phone": 620004 } ], "resultDesc": [ { "agentId": 55002, "phone": 620001 }, { "agentId": 833, "phone": 620002 }, { "agentId": 834, "phone": 620003 }, { "agentId": 835, "phone": 620004 } ] }