AXB模式接口使用说明
X表示隐私号码，A、B为相互保密的两个业务受益用户，A和B用户之间不知道对方真实号码的存在，他们互相通讯使用的被叫号码都是X。
AXB模式场景下X号码允许被多组号码进行绑定，同一个X号码不能被相同的A或者B号码同时绑定。如果您想要了解隐私保护通话AXB模式的功能，请参考AXB模式功能详解。
AXB模式相关接口如下：
|
接口名称 |
接口功能 |
请求发起方 |
请求接收方 |
备注 |
|---|---|---|---|---|
|
设置用户A、隐私号码X和用户B之间的绑定关系 |
客户应用（客户端） |
隐私保护通话平台（服务端） |
设置了AXB的绑定关系后，A和B才可通过X号码进行联系。 |
|
|
修改已设置的AXB绑定关系的相关信息 |
客户应用（客户端） |
隐私保护通话平台（服务端） |
- |
|
|
查询已设置的AXB绑定关系的相关信息 |
客户应用（客户端） |
隐私保护通话平台（服务端） |
- |
|
|
隐私保护通话平台向客户推送隐私保护通话用户呼叫时的状态信息，如呼入、呼出、振铃、应答、挂机等状态的信息 |
隐私保护通话平台（服务端） |
客户应用（客户端） |
若要接收呼叫事件通知，客户添加应用时需设置呼叫状态接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 |
|
|
隐私保护通话平台向客户推送通话的话单信息 |
隐私保护通话平台（服务端） |
客户应用（客户端） |
若要接收话单通知，客户添加应用时需设置呼叫话单接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 |
|
|
X号码状态变化时，隐私保护通话平台会向客户推送X号码状态通知 |
隐私保护通话平台（服务端） |
客户应用（客户端） |
若要接收X号码状态通知，客户添加应用时需设置呼叫状态接收地址并启用推送X号码状态功能，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 |
|
|
隐私保护通话平台向客户推送隐私号短信通知 |
隐私保护通话平台（服务端） |
客户应用（客户端） |
若要接收短信通知，客户添加应用时需设置短信通知接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。 |
|
|
解除已设置的AXB绑定关系 |
客户应用（客户端） |
隐私保护通话平台（服务端） |
绑定关系使用完毕后（例如A和B的订单结束，不再需要互相联系），客户可解除绑定关系，以达到重复使用隐私号码资源的目的。 |
|
|
获取录音文件的下载地址 |
客户应用（客户端） |
隐私保护通话平台（服务端） |
客户从呼叫话单中获取到录音文件名后，可通过调用此接口获取录音文件下载地址。 |
API请求地址
API请求地址由“APP接入地址”和“访问URI”组成，数据来源如下：
|
参数 |
来源 |
示例 |
|---|---|---|
|
APP接入地址 |
登录管理控制台，从隐私保护通话“应用管理”页面获取。 |
https://rtcpns.cn-north-1.myhuaweicloud.com |
|
访问URI |
从各API接口页面中的“接口类型说明”中获取。 |
AXB模式绑定接口：/rest/caas/relationnumber/partners/v1.0 |
综上，API请求地址示例如下：
https://rtcpns.cn-north-1.myhuaweicloud.com/rest/caas/relationnumber/partners/v1.0
注意事项
- 因运营商管控，固话号码只能接收来自X号码的呼叫，不能作为主叫呼叫X号码。即AXB模式中，当A用户的号码为固话号码时，B用户（手机号码）可以拨打X号码联系A用户，但A用户无法通过拨打X号码联系B用户，反之亦然。
- 若需双向呼叫，A和B号码都必须是手机号码。
