检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
语音通知API 语音通知API使用说明 语音通知API 语音通知呼叫状态通知API 语音通知话单通知API
典型场景 SP通过请求响应或者呼叫状态和话单通知API获取到sessionid后,若需要终止呼叫,可调用“终止呼叫场景API”。 接口功能 开发者在开发应用时,通过调用终止呼叫场景API,可以实现终止呼叫的功能。 如果业务已经执行完毕,终止呼叫API会返回失败。 图1 终止呼叫体验流程
API功能 语音通知API 请求语音通话平台向指定用户播放语音通知。 语音通知呼叫状态通知API 语音通话平台向SP推送接收语音通话业务用户呼叫时的状态信息,如呼入、呼出、振铃、应答、挂机等状态的信息。 语音通知话单通知API 通话结束后,语音通话平台向SP推送通话的话单信息。 API请求地址
接通后主动挂机 7001 开发者呼叫频次管控 7002 应用呼叫频次管控 7003 固话号码呼叫频次管控 7004 被叫黑名单呼叫管控 7108 用户状态已冻结 7109 语音端口不足 8000 内部错误 8001 用户未接续成功,可能包含以下场景: 开发者/应用/固话号码呼叫频次
坐席不可用,拒接呼入 2863 留言创建录音失败 2868 企业已停机 2871 动态ivr等待sp指令超时 2901~2914 录音失败 7001 开发者呼叫频次管控 7002 应用呼叫频次管控 7003 显示号码呼叫频次管控 7004 被叫黑名单呼叫管控 7005 主叫黑名单呼叫管控 7100
String(1-256) 无 此字段用于SP开发者自定义呼叫发起时,设置用户的附属信息,应用场景可以是当开发者想要对每一次呼叫的用户进行跟踪时,该参数可以携带用于标识用户的信息,如customerId123。 语音通话平台不对此参数做强制要求,如果开发者传入此参数,语音通话平台会在后续发给SP的通知消息中携带该参数值。
附录 通话挂机原因值说明 附录1-Q850原因值说明 附录2-呼叫拆线点说明 附录3-其他附加性说明
概述 欢迎使用语音通话服务(VoiceCall)。语音通话服务以云服务的方式提供语音通信能力,支持语音回呼、语音验证码、语音通知。方便快捷,拨通率高;安全可靠,防盗取,防攻击;性能稳定,支持大容量、高并发 本文档提供了语音通话API的描述、参数说明及示例等内容。支持的全部操作请参见API接口使用说明。
提供呼叫状态接收URL有以下两种方式: 提前通过应用管理向语音通话平台提交呼叫状态接收URL。 SP应用调用场景API时,填写statusUrl。 使用限制 语音通话平台推送呼叫状态给开发者应用,仅支持POST方式。 接口类型 表1 接口类型说明 请求方法 POST 访问URI 开发者应用接收呼叫状态URL 通信协议
e)相同,话单会合并在一起发送,最多不超过50条。 使用限制 语音通话平台推送话单信息给开发者应用,仅支持POST方式。 接口类型 表1 接口类型说明 请求方法 POST 访问URI 开发者应用接收话单通知的URL 通信协议 HTTPS/HTTP 语音回呼场景请求参数 表2 请求Headers参数说明
提供呼叫状态接收URL有以下两种方式: 提前通过应用管理向语音通话平台提交呼叫状态接收URL。 SP应用调用场景API时,填写statusUrl。 使用限制 语音通话平台推送呼叫状态给开发者应用,仅支持POST方式。 接口类型 表1 接口类型说明 请求方法 POST 访问URI 开发者应用接收呼叫状态URL 通信协议
语音回呼API 语音回呼API使用说明 语音回呼场景API 终止呼叫场景API 语音回呼呼叫状态通知API 语音回呼话单通知API 获取录音文件下载地址API
提供呼叫状态接收URL有以下两种方式: 提前通过应用管理向语音通话平台提交呼叫状态接收URL。 SP应用调用场景API时,填写statusUrl。 使用限制 语音通话平台推送呼叫状态给开发者应用,仅支持POST方式。 接口类型 表1 接口类型说明 请求方法 POST 访问URI 开发者应用接收呼叫状态URL 通信协议
文档修订记录 发布日期 修订记录 2022/5/7 话单通知接口的recordFileDownloadUrl参数长度由“String(1-256)”修改为“String(1-1024)”。 2020/7/28 新增API错误码1013112-1013118 2019/9/17 语
语音验证码API 语音验证码API使用说明 语音验证码场景API 语音验证码呼叫状态通知API 语音验证码话单通知API
叫接听后业务平台向被叫播放语音,并进行收号。SP可以要求业务平台播放多段语音,每段语音的内容都可以是下列两种语音中的一种: 语音文件中录制的语音。 文本(需要先通过模板定义)通过TTS服务转换成的语音。 业务体验描述: SP想要给用户A通知一段或多段语音。 SP向语音通话平台发送播放语音通知业务请求。
语音验证码是SP将被叫号码和数字验证码发送给业务平台,由业务平台呼叫被叫,并在被叫接听后播放验证码。 业务体验描述: SP想要给用户A通知一串数字验证码。 SP向语音通话平台发送播放语音验证码业务请求。 语音通话平台呼叫用户A的号码。 用户A接听。 语音通话平台向用户A播放验证码。 使用说明 前提条件
语音通知话单通知API 接口功能 用户通话结束后,语音通话平台通过此接口向SP推送通话的话单信息。短时间内有多个通话结束时语音通话平台会将话单合并推送,每条消息最多携带50个话单。 请求方向 语音通话平台(客户端) → 客户服务器(服务端) 使用说明 前提条件 SP在开发应用时,
附录3-其他附加性说明 本文档中提供的API接口均采用短连接(短信接口除外,短信接口可支持长连接。),平台服务器作为服务端时会主动拆链,建议SP作为客户端时不要主动拆链,等接收到服务端的FIN, ACK后按照正常四次挥手拆链。 若SP主动拆链,可能造成该链路对应的端口短时间不可用,影响SP发送请求。
终止呼叫场景API 实现通话双方终止呼叫。 语音回呼呼叫状态通知API 语音通话平台向SP推送接收语音通话业务用户呼叫时的状态信息,如呼入、呼出、振铃、应答、挂机等状态的信息。 语音回呼话单通知API 通话结束后,语音通话平台向SP推送通话的话单信息。 获取录音文件下载地址API 获取通话后的录音文件下载地址。