本产品（
号码隐私保护服务/2017-05-25）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
添加号码绑定
| API | 标题 | API概述 |
|---|---|---|
| BindAxb | AXB中间号-号码绑定 | AXB中间号，是将拨打关系限定在一对一关系中，用户A可以通过中间号码X联系到用户B，用户B也可以通过中间号码X联系到用户A。 |
| BindAxn | AXN隐私号-号码绑定 | 添加AXN隐私号的绑定关系。AXN隐私号是为A用户分配一个专属的隐私号，任何号码N通过拨打X号码都可以转接到A。 |
| BindAxnExtension | AXN分机号-号码绑定 | 添加AXN分机号的绑定关系。AXN分机号与AXN隐私号功能类似，AXN分机号在AXN基础上引入了分机号，从而降低X号码的使用量，在呼叫时候首先拨打X号码，听到提示音后输入对应分机号转接到A。 |
| BindAxg | AXG隐私号-号码绑定 | 添加AXG号码的绑定关系。AXG产品是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案，其中G代表一个号码组，可以根据需要添加号码。 |
| BindBatchAxg | 批量添加AXG号码的绑定关系 | 批量添加AXG号码的绑定关系。AXG产品是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案，其中G代表一个号码组，可以根据需要添加号码。 |
| UpdateSubscription | 修改已绑定的号码 | 修改号码的绑定关系。 |
| UnbindSubscription | 解除已绑定的号码 | 解除号码的绑定关系。 |
查询号码绑定
| API | 标题 | API概述 |
|---|---|---|
| QuerySubscriptionDetail | 查询号码绑定详情 | 查询号码的绑定详情。获取号码绑定关系状态、分机号码、是否录音、ASR状态等信息。 |
| QuerySubsId | 查询号码绑定ID | 查询绑定关系的唯一标识SubsId。 |
| QuerySecretNoDetail | 查询隐私号码属性 | 查询隐私号码的属性信息。 |
G号码组
| API | 标题 | API概述 |
|---|---|---|
| CreateAxgGroup | 创建G号码组 | 创建G号码组。仅AXG隐私号类型的号码池支持设置G号码组。 |
| OperateAxgGroup | 修改G号码组 | 修改G号码组中的号码，可以对号码进行添加、删除、全量替换操作。 |
| DeleteAxgGroup | 删除G号码组 | 删除G号码组。仅AXG隐私号类型的号码池支持设置G号码组。 |
录音及ASR获取
| API | 标题 | API概述 |
|---|---|---|
| QueryRecordFileDownloadUrl | 获取录音文件的下载链接 | 根据号码池Key、呼叫记录ID、呼叫发起时间等获取录音文件的下载链接。 |
| GetTotalPublicUrl | 获取响铃放音的录音下载链接 | 获取响铃放音的录音下载链接。 |
| GetSecretAsrDetail | 获取ASR识别结果详情 | 获取ASR识别结果详情。 |
号码资源管理
| API | 标题 | API概述 |
|---|---|---|
| AddSecretBlacklist | 添加黑名单 | 向号码池添加黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。 |
| DeleteSecretBlacklist | 删除黑名单 | 删除号码池的黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。 |
| OperateBlackNo | 新增或删除黑名单 | 新增或删除号池黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。 |
| ReleaseSecretNo | 释放号码 | 释放号码。释放后所选号码将不可继续使用。 |
| LockSecretNo | 锁定号码 | 锁定号码。适用于需要临时屏蔽异常号码的场景。 |
| UnlockSecretNo | 解锁号码 | 解锁号码。解除号码的临时屏蔽。 |
电商物流行业接口
| API | 标题 | API概述 |
|---|---|---|
| CreatePickUpWaybillPreQuery | 寄件下单预查询 | 寄件下单预查询。 |
| CreatePickUpWaybill | 创建上门寄件订单 | 创建上门寄件订单。 |
| CancelPickUpWaybill | 取消上门寄件订单 | 取消上门寄件订单。 |
| AddAxnTrackNo | 为AXN隐私号添加运单号 | 为AXN隐私号添加运单号。 |
| QueryPhoneNoAByTrackNo | 进行运单号广播推送 | 广播推送运单号。 |