查询呼叫状态 (queryCallState)
场景描述
查询呼叫状态。
接口方法
POST
接口URI
https://域名/apiaccess/CC-Management/v1/mobileAgent/queryCallState，例如域名是service.besclouds.com
请求说明
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
|
1 |
X-APP-Key |
string |
False |
appKey字段，用户标识 |
|
2 |
Authorization |
string |
True |
鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） |
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
|
1 |
callSerialNo |
string |
True |
呼叫流水号 长度限制：string（50） |
响应说明
- 响应状态码: 200
|
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|---|
|
1.1 |
retCode |
string |
True |
返回码。0表示成功，其他为失败。 1：查询状态失败 3：呼叫流水号格式不符 |
|
1.2 |
retMsg |
string |
True |
失败原因的描述 |
|
1.3 |
result |
object |
False |
返回结果 |
|
1.3.1 |
state |
number |
False |
呼叫状态： 0：待呼叫 1：正在呼叫 2：通话中 3：通话结束 长度限制：number（1） |
|
1.3.2 |
reasonCode |
number |
False |
通话结束原因码： 0~65535， 0: 通话结束，被叫挂机 1：通话结束，主叫挂机 2：外呼主叫失败 3：外部被叫失败 4：外呼主叫无应答 5：外呼被叫无应答 6：启动呼叫失败 xxx：其他异常 长度限制：number（5） 针对ITA双呼还有一些reasonCode，请参见表4 |
|
1.3.3 |
callData |
string |
False |
第三方自定义的呼叫数据信息 长度限制：string（1024） |
|
1.3.4 |
caller |
string |
False |
主叫号码 长度限制：string（32） |
|
1.3.5 |
called |
string |
False |
被叫号码 长度限制：string（32） |
|
1.3.6 |
startTime |
string |
False |
外呼开始时间，时间戳，如1572794607000 |
|
1.3.7 |
endTime |
string |
False |
通话结束时间，时间戳，如1572794607000 |
|
1.3.8 |
callerPresent |
string |
False |
外显号码，来电显示的号码 长度限制：string（32） |
|
1.3.9 |
agentPresent |
string |
False |
外显号码，客户经理来电显示的号码 |
|
retCode |
原因值描述 |
|---|---|
|
0 |
不涉及 |
|
1 |
无法找到号码 |
|
2 |
无法路由到网络 |
|
3 |
无法路由到目的地 |
|
4 |
发送特殊消息 |
|
5 |
中继前缀出错 |
|
6 |
通道无法接入 |
|
7 |
已经建立频道 |
|
8 |
抢先占有 |
|
9 |
抢先占有保留 |
|
16 |
正常呼叫清除 |
|
17 |
用户忙 |
|
18 |
无应答 |
|
19 |
无用户应答 |
|
20 |
用户不可及 |
|
21 |
拒绝呼叫 |
|
22 |
号码已改变 |
|
23 |
重定向 |
|
25 |
交换路由错误 |
|
26 |
无用户准许 |
|
27 |
目标无序 |
|
28 |
非法号码格式 |
|
29 |
设备拒绝 |
|
30 |
状态查询 |
|
31 |
正常 |
|
34 |
路由不可达 |
|
38 |
网络状态不好 |
|
39 |
服务链接不上 |
|
40 |
链接进行中 |
|
41 |
暂时失败 |
|
42 |
设备拥塞 |
|
43 |
信息丢弃 |
|
44 |
通道无法接入 |
|
46 |
呼叫阻塞 |
|
47 |
无可用资源 |
|
49 |
品质无效 |
|
50 |
设备没预订 |
|
53 |
闭合群OCB呼出受限 |
|
55 |
闭合群ICB呼入受限 |
|
57 |
无权限发送 |
|
58 |
发送无效 |
|
62 |
等级不一致 |
|
63 |
服务无效 |
|
65 |
发送无法执行 |
|
66 |
通道无法执行 |
|
69 |
设备无效 |
|
70 |
发送有效 |
|
79 |
CV服务没设置 |
|
81 |
引用非法值 |
|
82 |
通道不存在 |
|
83 |
ID不存在 |
|
84 |
呼叫ID不存在 |
|
85 |
无呼叫等待 |
|
86 |
隐藏号码呼叫 |
|
87 |
CUG无成员 |
|
88 |
目标冲突 |
|
90 |
CUG不存在 |
|
91 |
无效网络 |
|
95 |
无效信息 |
|
96 |
非托管元素 |
|
97 |
类型不存在 |
|
98 |
信息没执行 |
|
99 |
信息单元不存在 |
|
100 |
无效的信息单元 |
|
101 |
呼叫状态不一致 |
|
102 |
定时器超时 |
|
103 |
参数不存在 |
|
110 |
消息中带有未识别的参数 |
|
111 |
协议错误 |
|
127 |
未指定的交互 |
- 响应状态码: 400
错误的请求：请检查请求路径及参数。
- 响应状态码: 401
未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到：请检查请求的路径。
- 响应状态码: 500
业务失败：请依次确认您请求中各参数的取值。
错误码
无。
报文样例
请求头:
x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json
请求参数:
{
"callSerialNo": "645735364434067472"
}
响应头:
{
"connection": "keep-alive",
"content-type": "application/json;charset=UTF-8"
}
响应参数:
{
"retMsg": "Query call state successfully",
"retCode": "0",
"result": {
"caller": "88889050",
"called": "88889060",
"callerPresent": "640003",
"startTime": 1621823865000,
"state": 3,
"reasonCode": 0,
"agentPresent": "640060",
"endTime": 1621823872000
}
}
