查询座席休息信息
场景描述
查询所有座席休息的信息。
接口方法
设置成“POST”。该接口仅支持POST方法,不支持PUT、GET和DELTE等方法。
内部封装接口
- CTI3.6 BMS接口:/ccbms/ws/monitor/teamrestinfo
- CTI3.6 BMS接口:/ccbms/ws/monitor/teamrestagentinfo
- CTI3.8 BMS接口:/ccbms/ws/monitor/queryAgentRestDetailInfo
请求URL
https://ip:port/rest/cmsapp/v1/openapi/agentgroup/agentrestinfos
其中,公有云环境请联系管理员获取,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 |
offset |
int |
False |
offset用于确定查询的起始页。 offset取值公式为:offset=limit*(page-1),取值范围:>=0 page为需要查询的起始页。 此字段只在CTI3.6版本生效 |
4 |
limit |
int |
False |
表示每页的查询数量。 取值范围:1~100 与offset要么同时存在,要么都不存在 此字段只在CTI3.6版本生效 |
响应消息
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
result |
String |
查询结果。取值如下:
失败的原因说明请参见错误码参考。
说明:
当前字段为兼容8.13及其之前版本接口响应参数使用。 |
2 |
resultCode |
string |
查询结果。取值如下:
失败的原因说明请参见错误码参考。 |
3 |
resultDatas |
Object |
查询成功后,返回结果信息的对象。 该数组中对象的参数说明请参见表4。
说明:
当前字段为兼容8.13及其之前版本接口响应参数使用。 |
4 |
resultDesc |
Object |
查询成功后,返回结果信息的对象。 该对象的参数说明请参见表4。 |
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
2.1 |
allowRestNum |
int |
已经允许休息人数,但是座席仍然未休息的座席人数 |
2.2 |
onRestNum |
int |
正在休息的座席数 |
2.3 |
waitRestNum |
Int |
申请休息的座席数 |
2.4 |
agentsRestDetails |
array |
VDN上休息座席的详情对象列表。 该对象的参数说明请参见表5。 |
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
2.4.1 |
agentName |
string |
座席名称。 |
2.4.2 |
workNo |
int |
座席工号。 |
2.4.3 |
cantRestReason |
int |
座席不允许休息的原因,此参数仅对于等待休息的座席有效。 该对象的参数说明请参见表6。 |
2.4.4 |
beginTime |
long |
开始时间(正在休息指休息开始时间,还未休息指申请或批准休息开始时间) 时间格式:时间戳 |
2.4.5 |
restDuration |
long |
请求休息时长,单位:秒。 |
样例报文
- 请求头:
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- 请求参数:
{ "queryParam": { "ccId":1, "vdn":1, "offset":0, "limit":100 } }
- 响应参数:
{ "result": "0", "resultCode": "0100000", "resultDatas": { "allowRestNum": 101, "onRestNum": 1, "waitRestNum": 0, "agentsRestDetails": [ { "agentName": "z1", "workNo": 55001, "cantRestReason": 1, "beginTime": 2345, "restDuration": 22333 } ] }, "resultDesc": { "allowRestNum": 101, "onRestNum": 1, "waitRestNum": 0, "agentsRestDetails": [ { "agentName": "z1", "workNo": 55001, "cantRestReason": 1, "beginTime": 2345, "restDuration": 22333 } ] } }