语音HTTP批量推送状态报告

最近更新时间:2021-09-17 15:02:19

查看PDF

描述

语音发送后,语音服务可以通过回调业务 URL (回调地址在控制台>语音消息>系统设置中进行配置)的方式,通知业务方语音下发的状态。

注意: 接入HTTP推送功能,请按照文档给的响应格式返回,否则会一直重推。
在返回响应结果之前,请确保接收状态报告服务已经正常处理完状态报告。

URL 示例

POST: http://example.com/voice_report/callback

请求说明

请求体为JSON格式,单次请求可能会包含多个(最多200)状态报告结果。

POST /voice_report/callback HTTP/1.1
Host:example.com
Content-Type:application/json;charset=UTF-8
Content-Length:1246
[
	{
	    "Status": "SUCCESS",
	    "EndTime": "2020-05-28 18:44:39",
	    "Duration": 19,
	    "CallId": "655e08e182c11590662652",
	    "ErrCode": "SUCCESS",
	    "ErrDesc": "发送成功",
	    "StartTime": "2020-05-28 18:44:10",
	    "AnswerTime": "2020-05-28 18:44:20",
	    "Mobile": "1xxxxxxxxxx",
	    "PressKey": "1",
	    "ExtId": "abcdefg111",
	    "Caller": "875100000",
	    "CallerDisplay": "875100000",
            "VoiceType":1,
	},
        {
	    "Status": "FAIL",
	    "EndTime": "",
	    "Duration": 0,
	    "CallId": "58983af181721590663223",
	    "ErrCode": 480,
	    "ErrDesc": "用户拒接",
	    "StartTime": "2020-05-28 18:44:10",
	    "AnswerTime": "",
	    "Mobile": "1xxxxxxxxxx",
	    "PressKey": "",
	    "ExtId": "abcdefg222",
	    "Caller": "875100000",
	    "CallerDisplay": "875100000",
            "VoiceType":2, 
	}
]
参数 描述
CallId 语音消息标识ID(对应语音发送接口返回的CallId)
ExtId 客户自定义流水号
Mobile 手机号
Status 语音呼叫结果,SUCCESS(成功)、FAIL(失败)
ErrCode 语音呼叫状态码
ErrDesc 语音呼叫状态码对应的失败原因
StartTime 语音发起时间
AnswerTime 语音接听时间
EndTime 语音结束时间
Duration 通话时长(秒)
PressKey 按键码
Caller 发送接口传的主叫号码
CallerDisplay 真实呼出的主叫显示号码
VoiceType 语音类型:1-语音验证码,2-语音通知

响应参数

{
  "code" : 0,
  "msg" : "success"
}
参数 类型 描述
code number 应答码,0表示成功,非0表示失败
msg string 描述信息,code 非0时的具体错误信息

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈