调用BindAxb接口添加AXB号码的绑定关系。

使用说明

绑定AXB号码前,建议明确您的业务场景中AXB设备证书(ProductKey、DeviceName、DeviceSecret)的A角色和B角色。例如,在打车应用场景中,A可以是乘客角色,B是司机角色;房产类业务场景中,A可能是用户,B是房产中介。

QPS限制

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String BindAxb

系统规定参数。取值:BindAxb

PoolKey String FC5526*****

号码池Key。

请登录号码隐私保护控制台,在号码池管理中查看号码池Key。

PhoneNoA String 150****0000

AXB中的A号码。

A号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符,例如0571xxxx688。

PhoneNoB String 150****0000

AXB中的B号码,A号码拨打X号码时会转接到B号码。

B号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符,例如0571xxxx688。

如需更新B号码,请调用UpdateSubscription接口更新。

PhoneNoX String 150****0000

AXB中的X号码。

X号码是您绑定号码前在号码隐私保护控制台或通过BuySecretNo接口购买的电话号码,用于转接电话。

如果未指定X号码,将根据参数ExpectCity从指定号码池中随机指定一个号码作为X号码。

Expiration String 2021-09-05 12:00:00

绑定关系的过期时间。

说明 必须晚于当前时间1分钟以上。
ExpectCity String 北京

指定城市进行X号码的选号。

  • 如果当前号码池中没有该城市的可用号码,或未指定此参数,将从当前号码池中随机分配一个其他城市的号码作为X号码。
  • 如果X号码分配模式配置为严格匹配模式,当符合条件的号码不存在时,系统会提示分配错误。
IsRecordingEnabled Boolean true

是否需要针对该绑定关系产生的所有通话录制通话录音。取值:

  • true:录音。
  • false:不录音。
OutId String abcdef

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

OutOrderId String 34553330****

外部业务ID。

CallRestrict String CONTROL_AX_DISABLE

单通呼叫限制的状态。取值:

  • CONTROL_AX_DISABLE:A号码无法呼叫X号码。
  • CONTROL_BX_DISABLE:B号码无法呼叫X号码。
CallDisplayType Integer 1

重置绑定关系中的号码显示逻辑。固定取值:1(主被叫显示中间号码X)。

说明 由于运营商监管限制,呼叫时显示真实号码的设置不生效。
RingConfig String {"AXBRing_B":"100000001","AXBRing_A":"100000001"}

设置AXB绑定关系中的企业彩铃放音编码,内容如下:

  • AXB中,A号码打X的铃音设置:AXBRing_A
  • AXB中,B号码打X的铃音设置:AXBRing_B
  • 企业彩铃编码:企业彩铃编码可以在管理控制台中查询,具体请登录号码隐私保护控制台,通过号码池管理>企业彩铃管理进行查看,支持上传、删除等操作。
说明 企业彩铃优先使用绑定级别设置的彩铃,如果未设置或设置未生效,则会使用号码池级别的彩铃音。
ASRStatus Boolean false

ASR状态。取值:

  • false:关闭(默认值)。
  • true:开启。
ASRModelId String 7ee372834d2f4cc7ac0d0ab****

ASR模型ID。可以在ASR模型管理页面查看ASR模型ID。

CallTimeout Integer 10

顺振时长。单位:秒。

返回数据

名称 类型 示例值 描述
Code String OK

请求状态码。

  • 返回OK代表请求成功。
  • 其他错误码,请参见错误码列表
Message String OK

状态码的描述。

RequestId String 9297B722-A016-43FB-B51A-E54050D9369D

请求ID。

SecretBindDTO Object

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

Extension String 130

分机号码。

说明 接口BindAxb不涉及分机号码,请忽略该返回参数。
SubsId String 10000007683*****

绑定关系ID。

SecretNo String 170****0000

隐私号码,即X号码。

示例

请求示例

https://dyplsapi.aliyuncs.com/?Action=BindAxb
&Expiration=2021-09-05 12:00:00
&PhoneNoA=150****0000
&PhoneNoB=150****0000
&PoolKey=FC5526*****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<BindAxbResponse>
<SecretBindDTO>
    <Extension>130</Extension>
    <SecretNo>170****0000</SecretNo>
    <SubsId>10000007683*****</SubsId>
</SecretBindDTO>
<Message>OK</Message>
<RequestId>9297B722-A016-43FB-B51A-E54050D9369D</RequestId>
<Code>OK</Code>
<BindAxbResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "SecretBindDTO" : {
    "Extension" : "130",
    "SecretNo" : "170****0000",
    "SubsId" : "10000007683*****"
  },
  "Message" : "OK",
  "RequestId" : "9297B722-A016-43FB-B51A-E54050D9369D",
  "Code" : "OK"
}

错误码

访问错误中心查看更多错误码。