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

BindAxg - 添加AXG号码的绑定关系

调用接口BindAxg添加AXG号码的绑定关系。

接口说明

AXG隐私号是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案,其中G代表一个号码组,可以根据需要添加号码。

QPS限制

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

调试

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

调试

授权信息

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

请求参数

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

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

FC123456
PhoneNoAstring

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

139****0000
GroupIdstring

AXG中的G组ID,即GID。 可以通过以下方式查看GID:

  • 号码隐私保护控制台中的号码池管理页面筛选出AXG隐私号,并单击G号码组管理即可查看所有G号码组的GID。
  • 如果G号码组是通过接口CreateAxgGroup创建的,则接口的返回参数GroupID就是此处的请求参数GroupID
说明G号码组中必须有一个及以上的电话号码。
1234
PhoneNoBstring

AXG中的B号码,A号码拨打X号码时会转接到B号码,可通过接口UpdateSubscription更新B号码。

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

139****0000
PhoneNoXstring

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

说明X号码是您绑定号码前在控制台或通过接口BuySecretNo购买的电话号码,用于转接电话。
139****0000
Expirationstring

绑定关系的过期时间,时间单位精确到秒。

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

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

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

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

true
OutIdstring

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

abcdef
OutOrderIdstring

外部业务ID。

abcdef
CallDisplayTypeinteger

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

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

设置AXG绑定级别企业彩铃放音,支持针对该绑定关系中设置,内容包括如下:

  • AXG中,A号码打X的铃音设置(有回拨号码):AXGRing_AB
  • AXG中,A号码打X的铃音设置(无回拨号码):AXGRing_A
  • AXG中,G组号码打X的铃音设置:AXGRing_G
  • 企业彩铃编码:企业彩铃编码可以在管理控制台中查询,具体通过号码隐私保护控制台>号码池管理>企业彩铃管理进行查看、管理,支持上传、删除等操作。
说明企业彩铃优先使用绑定级别设置的彩铃,如果未设置或设置未生效,则会使用号码池级别的彩铃音。
{"AXGRing_AB":"100000001","AXGRing_A":"100000002","AXGRing_G":"100000003"}
ASRStatusboolean

ASR状态。取值:

  • False:关闭(默认值)
  • True:开启
False
ASRModelIdstring

ASR模型ID。

123456
CallRestrictstring

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

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

返回参数

名称类型描述示例值
object
Codestring

请求状态码。

OK
Messagestring

状态码的描述。

OK
RequestIdstring

请求ID。

F655A8D5-B967-440B-8683-DAD6FF8DE990
SecretBindDTOobject

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

Extensionstring

分机号码。

说明接口BindAxg不涉及分机号码,请忽略该返回参数。
139****0000
SubsIdstring

订购关系ID。

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

隐私号码,即X号码。

139****0000

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
  "SecretBindDTO": {
    "Extension": "139****0000",
    "SubsId": "1************3",
    "SecretNo": "139****0000"
  }
}

错误码

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

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