接口调用说明
通过该接口查询当前实时接待统计数据,包括在线客服状态统计,当前转人工数量,接待中数量及排队中数量。
请求 URL 示例
https://console.tim.qq.com/v4/desk_http_svc/describe_reception_realtime_statistics?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/desk_http_svc/describe_reception_realtime_statistics | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json 。 |
请求包示例
{}
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "","Data": {"CurrentTransferAgentCnt": 15,"CurrentAgentAcceptCnt": 13,"CurrentQueueCnt": 2,"FreeAgentCnt": 10,"RestAgentCnt": 2,"BusyAgentCnt": 3,"CurrentGroupQueueCnt": [{"GroupId": 6103,"GroupName": "128931","QueueCnt": 0}]}}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码: 0表示成功。 非0表示失败。 |
ErrorInfo | String | 错误信息。 |
Data | Object | 实时统计数据信息。 |
CurrentTransferAgentCnt | Integer | 当前转人工会话数。 |
CurrentAgentAcceptCnt | Integer | 当前正在人工接待中会话数。 |
CurrentQueueCnt | Integer | 当前正在排队会话数。 |
FreeAgentCnt | Integer | 当前示闲状态客服人数。 |
RestAgentCnt | Integer | 当前小休状态客服人数。 |
BusyAgentCnt | Integer | 当前示忙状态客服人数。 |
CurrentGroupQueueCnt | Object | 当前客服分组排队信息。 |
GroupId | Integer | 分组信息。 |
GroupName | String | 分组名称。 |
QueueCnt | Integer | 当前分组排队人数。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 描述 |
141000 | 该应用非智能客服应用。 |
141002 | 内部错误,请重试。 |
141004 | 参数非法。 |
141009 | 接口限频。 |
接口调试工具