AXYB模式接口使用说明
隐私保护通话AXYB模式中，如A和B是同一个应用的两方用户，隐私保护通话平台为A、B分别绑定隐私号码X、Y。绑定完成后，A用户对B用户呈现X号码，与A用户建立的通信通过X号码建立；B用户对A用户呈现Y号码，与B用户建立的通信通过Y建立。如果您想要了解隐私保护通话AXYB模式的功能，请参考AXYB模式功能详解。
AXYB模式相关接口如下：
接口名称 |
接口功能 |
请求发起方 |
请求接收方 |
备注 |
|---|---|---|---|---|
设置以下绑定关系：
|
客户应用（客户端） |
隐私保护通话平台（服务端） |
客户调用此接口分别设置了A和X、B和Y的绑定关系后，A、B才可以通过X、Y实现通讯。 |
|
查询已设置的AXYB模式的绑定信息 |
客户应用（客户端） |
隐私保护通话平台（服务端） |
- |
|
隐私保护通话平台向客户推送隐私保护通话用户呼叫时的状态信息，如呼入、呼出、振铃、应答、挂机等状态的信息 |
隐私保护通话平台（服务端） |
客户应用（客户端） |
若要接收呼叫事件通知，客户添加应用时需设置呼叫状态接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 |
|
隐私保护通话平台向客户推送通话的话单信息 |
隐私保护通话平台（服务端） |
客户应用（客户端） |
若要接收话单通知，客户添加应用时需设置呼叫话单接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 |
|
X号码状态变化时，隐私保护通话平台会向客户推送X号码状态通知 |
隐私保护通话平台（服务端） |
客户应用（客户端） |
若要接收X号码状态通知，客户添加应用时需设置呼叫状态接收地址并启用推送X号码状态功能，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 |
|
解除以下绑定关系：
|
客户应用（客户端） |
隐私保护通话平台（服务端） |
绑定关系使用完毕后，客户可解除绑定关系，以达到重复使用隐私号码资源的目的。 |
|
获取录音文件的下载地址 |
客户应用（客户端） |
隐私保护通话平台（服务端） |
客户从呼叫话单中获取到录音文件名后，可通过调用此接口获取录音文件下载地址。 |
API请求地址
API请求地址由“APP接入地址”和“访问URI”组成，数据来源如下：
参数 |
来源 |
示例 |
|---|---|---|
APP接入地址 |
登录管理控制台，从隐私保护通话“应用管理”页面获取。 |
https://rtcpns.cn-north-1.myhuaweicloud.com |
访问URI |
从各API接口页面中的“接口类型说明”中获取。 |
AXYB模式绑定接口：/rest/omp/xyrelationnumber/v1.0 |
综上，API请求地址示例如下：
https://rtcpns.cn-north-1.myhuaweicloud.com/rest/omp/xyrelationnumber/v1.0
注意事项
因运营商管控，固话号码只能接收来自X号码的呼叫，不能作为主叫呼叫X号码。即AXYB模式中，当A用户的号码为固话号码时，B用户（手机号码）可以拨打X号码联系A用户，但A用户无法通过拨打Y号码联系B用户。
