首页 号码隐私保护 API参考 API目录 号码绑定 BindAxb - 添加AXB号码的绑定关系

BindAxb - 添加AXB号码的绑定关系

添加AXB号码的绑定关系。

接口说明

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

QPS限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PoolKeystring

号码池Key。

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

FC5526*****
PhoneNoAstring

AXB中的A号码。

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

139****0000
PhoneNoBstring

AXB中的B号码,A号码拨打X号码时会转接到B号码。 B号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符。

说明如需更新B号码,请调用UpdateSubscription接口更新。
139****0000
PhoneNoXstring

AXB中的X号码。

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

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

139****0000
Expirationstring

绑定关系的过期时间。

说明必须晚于当前时间1分钟以上。
2021-09-05 12:00:00
ExpectCitystring

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

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

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

  • true:录音。
  • false:不录音。
true
OutIdstring

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

abcdef
OutOrderIdstring

外部业务ID。

34553330****
CallRestrictstring

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

  • CONTROL_AX_DISABLE:A号码无法呼叫X号码。
  • CONTROL_BX_DISABLE:B号码无法呼叫X号码。
CONTROL_AX_DISABLE
CallDisplayTypeinteger

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

说明由于运营商监管限制,呼叫时显示真实号码的设置不生效。
1
RingConfigstring

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

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

    ASR状态。取值:

    • false:关闭(默认值)。
    • true:开启。
    false
    ASRModelIdstring

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

    7ee372834d2f4cc7ac0d0ab****
    CallTimeoutinteger

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

    10

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Codestring

    请求状态码。

    OK
    Messagestring

    状态码的描述。

    OK
    RequestIdstring

    请求ID。

    9297B722-A016-43FB-B51A-E54050D9369D
    SecretBindDTOobject

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

    Extensionstring

    分机号码。

    说明接口BindAxb不涉及分机号码,请忽略该返回参数。
    130
    SubsIdstring

    绑定关系ID。

    1**************3
    SecretNostring

    隐私号码,即X号码。

    139****0000

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    阿里云首页 号码隐私保护 相关技术圈