BindAxb_号码隐私保护服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 在调用此接口前,请确保您已在控制台购买隐私号

  • 您可以使用此接口给 AXB 中间号绑定号码,也可以在控制台号码管理页面给 AXB 中间号绑定 A、B 号码。

  • AXB 中间号,绑定号码前建议您先明确业务场景中的 A 角色和 B 角色。例如:在打车应用场景中,A 是乘客角色,B 是司机角色。

  • AXB 中间号主要应用在 1 对 1 场景下的隐私保护,客户把 A 号码和 B 号码通过号码隐私服务实现绑定关系,A 拨打 X 转接到 B,B 拨打 X 转接到 A;一个 X 号码可以供 200 对绑定关系复用,如 A1XB1、A2XB2、A3XB3......,只要 A、B 用户手机号码不重复,一个 X 号码可同时绑定 200 组手机号码,通话也可以同时进行。

QPS 限制

本接口的单用户 QPS 限制为 5000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

流控信息

请求速率为5000/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dypls:BindAxb
Create
全部资源
*

请求参数

字段名称字段详情
PoolKeystring

号码池 Key。展开详情

示例值:FC10000016848****
PhoneNoAstring

AXB 中间号的 A 号码。展开详情

示例值:139****0000参考取值来源:
    QueryPhoneNoAByTrackNo
PhoneNoBstring

AXB 中间号的 B 号码。展开详情

示例值:136****0000参考取值来源:
    QueryPhoneNoAByTrackNo
PhoneNoXstring

AXB 中间号的 X 号码。展开详情

示例值:171****1893参考取值来源:
    QueryPhoneNoAByTrackNo
Expirationstring

号码绑定的过期时间。展开详情

示例值:2021-09-05 12:00:00
ExpectCitystring

指定城市进行 X 号码的选号。展开详情

示例值:北京
IsRecordingEnabledboolean

是否开启通话录音功能。取值:展开详情

示例值:false
OutIdstring

外部业务扩展字段,通话记录回执消息中会回传此参数。

示例值:abcdef
OutOrderIdstring

外部业务 ID。

示例值:34553330****
CallRestrictstring

单次呼叫限制的状态。取值:展开详情

示例值:CONTROL_AX_DISABLE枚举值:CONTROL_AX_DISABLECONTROL_BX_DISABLECONTROL_CLEAR_DISABLE
CallDisplayTypeinteger<int32>

重置绑定关系中的号码显示逻辑。固定取值 1,即主叫和被叫显示中间号码 X。展开详情

示例值:1
RingConfigstring

彩铃配置,AXB 中间号号码绑定后,拨打 X 号码的企业彩铃;此参数请填写铃音字段彩铃编码展开详情

示例值:{ "AXBRing_B": "1000****1", "AXBRing_A": "1000****1" }
ASRStatusboolean

是否开启 ASR 服务功能。取值:展开详情

示例值:false
ASRModelIdstring

ASR 模型 ID。取值:展开详情

示例值:7ee372834d2f4cc7ac0d0ab2d0ae1aac
CallTimeoutinteger<int32>

顺振时长。单位:秒。取值范围为 5~20。

示例值:10秒取值 <= 180
DtmfConfigstring

dtmf 按键配置,设置 AXB 中间号号码绑定时使用,可配置内容如下:展开详情

示例值:{ "endCallIvrPhoneNo":"A", "waitingDtmfTime":10, "maxLoop":3, "step1File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_1.wav", "step2File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_2.wav", "validKey":"1,2", "waitingEndCall":2 }

返回参数

字段名称字段详情
Codestring

请求状态码。展开详情

示例值:OK
Messagestring

状态码的描述。

示例值:OK
RequestIdstring

请求 ID。

示例值:9297B722-A016-43FB-B51A-E54050******
SecretBindDTOobject

号码绑定成功后返回的结构体。

返回示例

变更历史

暂无变更历史

相关示例

通过号码隐私保护的 OpenAPI 购买隐私号码,并进行绑定和解绑
2021-02-16
AXB中间号主要应用于1对1的场景下得隐私保护,前置条件是A、B的联系方式已知。
2021-12-21