调用接口UpdateSubscription修改绑定关系。

使用说明

添加号码绑定关系后,可以通过接口UpdateSubscription修改绑定关系,例如修改A号码、修改B号码、修改绑定关系有效期、设置单通呼叫限制或修改G号码组。

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:UpdateSubscription

PoolKey String FC122356****

号码池Key。

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

ProductType String AXB_170

产品类型。

说明 适用于原阿里大于客户,阿里云用户可忽略。
SubsId String 100000076879****

绑定关系ID。

请登录号码隐私保护控制台,选择号码管理 > 号码详情查看绑定关系ID,或者在调用BindAxb等号码绑定API时查看返回参数中的SubsId

PhoneNoX String 1500000*****

号码绑定关系中的X号码。

PhoneNoA String 1500000****

设置绑定关系中的A号码。

说明 当OperateType指定为updateNoA时必填。
PhoneNoB String 1500000****

设置绑定关系中的B号码,当OperateType指定为updateNoB时必填。

GroupId String 1234

设置绑定关系中的G号码组ID。

说明 当OperateType指定为updateAxgGroup时必填。
CallRestrict String CONTROL_BX_DISABLE

设置单通呼叫限制。当OperateType指定为updateCallRestrict时必填。取值:

  • CONTROL_AX_DISABLE:A号码无法呼叫X号码。
  • CONTROL_BX_DISABLE:B号码无法呼叫X号码。
  • CONTROL_CLEAR_DISABLE:清除呼叫限制。
Expiration String 2019-09-05 12:00:00

重新设置绑定关系的过期时间。

说明
  • OperateTypeupdateExpire时必填。
  • 过期时间必须晚于当前时间1分钟以上。
CallDisplayType Integer 1

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

说明 由于运营商监管限制,暂时关闭透传功能。呼叫时,显示真实号码的设置不生效。
OutId String abcdef

重新设置绑定关系中的OutId。

IsRecordingEnabled Boolean true

重新设置绑定关系中的录音状态。

OperateType String updateNoA

修改绑定关系的操作。取值:

  • updateNoA:修改A号码。
  • updateNoB:修改B号码。
  • updateExpire:修改绑定关系有效期。
  • updateAxgGroup:修改G号码组。
  • updateCallRestrict:设置单通呼叫限制。
  • updateCallDisplayType:更新呼叫显号逻辑。
  • updateOutId:更新OutId字段。
  • updateIsRecordingEnabled:更新绑定中录音状态。
RingConfig String {"AXBRing_B":"100000001","AXBRing_A":"100000001"}

更新绑定关系中的企业彩铃放音编码:

AXB产品:

  • AXB中,A号码打X的铃音设置:AXBRing_A
  • AXB中,B号码打X的铃音设置:AXBRing_B

AXN产品:

  • AXN中,A号码打X的铃音设置(有回拨号码):AXNRing_AB
  • AXN中,A号码打X的铃音设置(无回拨号码):AXNRing_A
  • AXN中,N侧号码打X的铃音设置:AXNRing_N

AXG产品:

  • AXG中,A号码打X的铃音设置(有回拨号码):AXGRing_AB
  • AXG中,A号码打X的铃音设置(无回拨号码):AXGRing_A
  • AXG中,G组号码打X的铃音设置:AXGRing_G

企业彩铃编码:企业彩铃编码可以在管理控制台中查询,具体通过号码隐私保护控制台>号码池管理>企业彩铃管理进行查看、管理,支持上传、删除等操作。

说明 企业彩铃优先使用绑定级别设置的彩铃,如果未设置或设置未生效,则会使用号码池级别的彩铃音。
ASRStatus Boolean false

ASR状态。取值:

  • false:关闭(默认值)
  • true:开启
ASRModelId String 980abddb908f48e8b987cb2cd303****

ASR模型ID。

返回数据

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

请求状态码。

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

状态码的描述。

RequestId String 986BCB6D-C9BF-42F9-91CE-3A9901233D36

请求ID。

示例

请求示例

https://dyplsapi.aliyuncs.com/?Action=UpdateSubscription
&OperateType=updateNoA
&PhoneNoX=150****0000
&PoolKey=FC123456
&SubsId=100000076879****
&<公共请求参数>

正常返回示例

XML格式

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

<?xml version="1.0" encoding="UTF-8" ?>
<UpdateSubscriptionResponse>
	<Message>OK</Message>
	<RequestId>986BCB6D-C9BF-42F9-91CE-3A9901233D36</RequestId>
	<Code>OK</Code>
</UpdateSubscriptionResponse>

JSON格式

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

{
  "Message" : "OK",
  "RequestId" : "986BCB6D-C9BF-42F9-91CE-3A9901233D36",
  "Code" : "OK"
}

错误码

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