释放事件回调接口
场景描述
推送释放呼叫事件。
接口方法
POST
接口URL
第三方系统自定义。
语音通知的回调URL支持两种配置方式:
- 通过界面配置:租户管理员选择,进入“语音通知回调配置”页签设置“挂机回调url”。
- 通过创建语音通知接口传入:调用创建通知接口时传入请求参数callBackUrl。
请求说明
- 请求头参数:
- 请求体参数:
序号
名称
参数类型
是否必选
说明
1
callSerialNo
string
True
呼叫流水号
长度限制:string(50)
2
called
string
True
被叫号码
3
signature
string
False
签名。
当通过创建语音通知接口传入回调URL,并在回调url配置界面中“请输入共享密钥”配置了共享密钥,为必选。
4
timestamp
string
False
时间戳
当通过创建语音通知接口传入回调URL,并在回调url配置界面中“请输入共享密钥”配置了共享密钥,为必选。
5
nonce
string
False
随机数
当通过创建语音通知接口传入回调URL,并在回调url配置界面中“请输入共享密钥”配置了共享密钥,为必选。
6
callerPresent
string
False
主叫外显号码。
7
createCallTime
string
False
发起呼叫时间。例如:2022/02/17,13:10:06:836
8
alertingTime
string
False
用户振铃时间。
9
talkingTime
string
False
通话时间。
10
releaseTime
string
False
释放时间。
11
talkDuration
string
False
通话时长。
12
recordfile
string
False
录音路径。
13
locationId
string
False
录音节点。
14
releaseReason
string
False
释放原因码。
0: 呼通后,被叫挂机;
1: 呼通后,通知播完挂机;
4: 被叫拒接、被叫振铃后超时未接;
6: 振铃前呼叫失败;
8:无资源;
9:排队机超时;
10:呼叫受限;
999:UAP拉起录音会场失败;
响应说明
响应码:200
- 响应消息
序号
名称
参数类型
是否必选
说明
1
retCode
string
True
0,成功,其他为失败。
2
retMsg
string
True
失败原因的描述。
报文样例
请求参数:
{
"alertingTime": "2022/02/22,10:04:29:004",
"callSerialNo": "1197765398201387012",
"called": "88880067",
"callerPresent": "960003",
"createCallTime": "2022/02/22,10:04:28:823",
"locationId": "0",
"nonce": "-1482421808053124529",
"recordfile": "Y:/2/mobileAgent/20220222/1645524268-824.wav",
"releaseReason": "0",
"releaseTime": "2022/02/22,10:04:36:318",
"signature": "+lk************************50=",
"talkDuration": "0",
"talkingTime": "2022/02/22,10:04:30:418",
"timestamp": "1645524163326"
}
响应参数:
{
"retCode": "0",
"retMsg": "success"
}