
# AX模式接口使用说明
X表示隐私号码，A为业务受益用户。A用户对外呈现的号码用X替代，所有与A用户建立的通讯都是通过X号码建立。
X号码只能被A号码独享，即不同A号码对应不同的X号码。如果您想要了解隐私保护通话AX模式的功能，请参考[AX模式功能详解](https://support.huaweicloud.com/productdesc-PrivateNumber/privatenumber_04_0002.html)。
AX模式相关接口如下：
| 接口名称                                                                                           | 接口功能                                                | 请求发起方         | 请求接收方         | 备注                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|:---|
| [AX模式绑定接口](https://support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0011.html)       | 设置用户A和隐私号码X之间的绑定关系                                  | 客户应用（客户端）     | 隐私保护通话平台（服务端） | 设置了AX的绑定关系后，其他人才可拨打X联系A。                                                                                                                                                                                                                                                                                                                                                                                         |
| [AX模式绑定信息修改接口](https://support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0013.html)   | 修改已设置的AX绑定关系的相关信息                                   | 客户应用（客户端）     | 隐私保护通话平台（服务端） | -                                                                                                                                                                                                                                                                                                                                                                                                                |
| [AX模式绑定信息查询接口](https://support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0014.html)   | 查询已设置的AX绑定关系的相关信息                                   | 客户应用（客户端）     | 隐私保护通话平台（服务端） | -                                                                                                                                                                                                                                                                                                                                                                                                                |
| [AX模式设置临时被叫接口](https://support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0015.html)   | 设置A拨打X呼叫的真实被叫                                       | 客户应用（客户端）     | 隐私保护通话平台（服务端） | - 每次A用户需要通过拨打X号码外呼前，客户都需要先调用该接口设置本次呼叫的临时被叫。  - 请在每次A用户发起呼叫前一分钟内调用此接口设置临时被叫。   |
| [AX模式呼叫事件通知接口](https://support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0006_1.html) | 隐私保护通话平台向客户推送隐私保护通话用户呼叫时的状态信息，如呼入、呼出、振铃、应答、挂机等状态的信息 | 隐私保护通话平台（服务端） | 客户应用（客户端）     | 若要接收呼叫事件通知，客户[添加应用](https://support.huaweicloud.com/usermanual-PrivateNumber/pn_um_01.html)时需设置呼叫状态接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。                                                                                                                                                                                                                                                                           |
| [AX模式话单通知接口](https://support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0006_1a.html)  | 隐私保护通话平台向客户推送通话的话单信息                                | 隐私保护通话平台（服务端） | 客户应用（客户端）     | 若要接收话单通知，客户[添加应用](https://support.huaweicloud.com/usermanual-PrivateNumber/pn_um_01.html)时需设置呼叫话单接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。                                                                                                                                                                                                                                                                             |
| [X号码状态通知接口](https://support.huaweicloud.com/api-PrivateNumber/numstatus_notify_ax.html)        | X号码状态变化时，隐私保护通话平台会向客户推送X号码状态通知                      | 隐私保护通话平台（服务端） | 客户应用（客户端）     | 若要接收X号码状态通知，客户[添加应用](https://support.huaweicloud.com/usermanual-PrivateNumber/pn_um_01.html)时需设置呼叫状态接收地址并启用推送X号码状态功能，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息。                                                                                                                                                                                                                                                              |
| [短信通知接口](https://support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0008.html)         | 隐私保护通话平台向客户推送隐私号短信通知                                | 隐私保护通话平台（服务端） | 客户应用（客户端）     | 若要接收短信通知，客户[添加应用](https://support.huaweicloud.com/usermanual-PrivateNumber/pn_um_01.html)时需设置短信通知接收地址，并确保提供的地址能够正常处理隐私保护通话平台发送的通知消息                                                                                                                                                                                                                                                                              |
| [AX模式解绑接口](https://support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0012.html)       | 解除已设置的AX绑定关系                                        | 客户应用（客户端）     | 隐私保护通话平台（服务端） | 绑定关系使用完毕后（例如A不再需要使用隐私号码），客户可解除绑定关系，以达到重复使用隐私号码资源的目的。                                                                                                                                                                                                                                                                                                                                                             |
| [获取录音文件下载地址接口](https://support.huaweicloud.com/api-PrivateNumber/privatenumber_02_0007_1.html) | 获取录音文件的下载地址                                         | 客户应用（客户端）     | 隐私保护通话平台（服务端） | 客户从呼叫话单中获取到录音文件名后，可通过调用此接口获取录音文件下载地址。                                                                                                                                                                                                                                                                                                                                                                            |
   
#### API请求地址
API请求地址由"APP接入地址"和"访问URI"组成，数据来源如下：
| 参数      | 来源                                                                                          | 示例                                               |
|:---|:---|:---|
| APP接入地址 | 登录管理控制台，从隐私保护通话"[应用管理](https://console.huaweicloud.com/privatenumber/#/appManagement)"页面获取。 | https://rtcpns.cn-north-1.myhuaweicloud.com      |
| 访问URI   | 从各API接口页面中的"接口类型说明"中获取。                                                                     | AX模式绑定接口：/rest/provision/caas/privatenumber/v1.0 |
   
综上，API请求地址示例如下：
设置AX模式绑定关系
```
https://rtcpns.cn-north-1.myhuaweicloud.com/rest/provision/caas/privatenumber/v1.0
```
#### API样例
下载Demo，快速开发应用：
- [Java](https://support.huaweicloud.com/devg-PrivateNumber/privatenumber_01_0001.html)
- [PHP](https://support.huaweicloud.com/devg-PrivateNumber/privatenumber_01_0006.html)
- [Python](https://support.huaweicloud.com/devg-PrivateNumber/privatenumber_01_0007.html)
- [C#](https://support.huaweicloud.com/devg-PrivateNumber/privatenumber_01_0012.html)
- [Node.js](https://support.huaweicloud.com/devg-PrivateNumber/privatenumber_01_0015.html)
 
#### 注意事项
因运营商管控，固话号码只能接收来自X号码的呼叫，不能作为主叫呼叫X号码。即AX模式中，当A用户的号码为固话号码时，其他用户（手机号码）可以拨打X号码联系A用户，但A用户无法通过拨打X号码联系其他用户。
