文档首页 > > API参考> X模式> X模式接口使用说明

X模式接口使用说明

分享
更新时间:2020/10/16 GMT+08:00

X表示隐私号码,隐私保护通话平台对外提供X号码呼叫和短信管道能力,但不存储任何绑定关系;隐私保护通话平台接收到呼叫或者短信后,会到客户服务器获取绑定关系。如果您想要了解隐私保护通话X模式的功能,请参考X模式功能详解

典型的X模式场景相关接口如下:

接口名称

接口功能

请求发起方

请求接收方

备注

X模式呼叫事件通知接口

隐私保护通话平台向客户推送隐私保护通话用户呼叫时的状态信息,如呼入、呼出、振铃、应答、挂机等状态的信息

隐私保护通话平台(服务端)

客户应用(客户端)

若要接收呼叫事件通知,客户添加应用时需设置呼叫状态接收地址,并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。

X模式话单通知接口

隐私保护通话平台向客户推送通话的话单信息

隐私保护通话平台(服务端)

客户应用(客户端)

若要接收话单通知,客户添加应用时需设置呼叫话单接收地址,并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。

X号码状态通知接口

X号码状态变化时,隐私保护通话平台会向客户推送X号码状态通知

隐私保护通话平台(服务端)

客户应用(客户端)

若要接收X号码状态通知,客户添加应用时需设置呼叫状态接收地址并启用推送X号码状态功能,并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。

短信通知接口

隐私保护通话平台向客户推送隐私号短信通知

隐私保护通话平台(服务端)

客户应用(客户端)

若要接收短信通知,客户添加应用时需设置短信通知接收地址,并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息

终止呼叫接口

终止一路呼叫

客户应用(客户端)

隐私保护通话平台(服务端)

客户可随时调用该接口终止一路隐私保护通话呼叫。

获取录音文件下载地址接口

获取录音文件的下载地址

客户应用(客户端)

隐私保护通话平台(服务端)

客户从呼叫话单中获取到录音文件名后,可通过调用此接口获取录音文件下载地址。

API请求地址

API请求地址由“APP接入地址”和“访问URI”组成,数据来源如下:

参数

来源

示例

APP接入地址

登录管理控制台,从隐私保护通话“应用管理”页面获取。

https://rtcapi.cn-north-1.myhuaweicloud.com:12543

访问URI

从各API接口页面中的“接口类型说明”中获取。

获取录音文件下载地址接口

:/rest/provision/voice/record/v1.0

综上,API请求地址示例如下:

获取录音文件下载地址接口
https://rtcapi.cn-north-1.myhuaweicloud.com:12543/rest/provision/voice/record/v1.0

API样例

下载Java代码样例,快速开发应用。

注意事项

因运营商管控,固话号码只能接收来自X号码的呼叫,不能作为主叫呼叫X号码。请使用手机号码作为主叫呼叫X号码。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问