AXB模式绑定信息修改接口

PUT

/rest/caas/relationnumber/partners/v1.0

HTTPS

Content-Type

是

String

固定填写为application/json;charset=UTF-8。

Authorization

是

String

固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。

X-AKSK

是

String

Java

yyyy-MM-dd'T'HH:mm:ss'Z'

PHP

Y-m-d\TH:i:s\Z

Python

%Y-%m-%dT%H:%M:%SZ

C#

yyyy-MM-ddTHH:mm:ssZ

Node.js

toISOString().replace(/.[0-9]+\Z/, 'Z')

注：Node.js中，使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。

subscriptionId

是

String(1-64)

指定“AXB模式绑定接口”返回的绑定ID进行修改。

callerNum

否

String(4-31)

将A号码修改为新的值。

填写为全局号码格式。

• 手机号码格式为国家码（如+86）+手机号码（11位数字的手机号码，如138****0001），填写为"+86138****0001"。

• 固话号码为国家码（如+86）+不带前置0的区号（如755）+本地固话号码（7或8位数字的固话号码，以实际号码为准，如28****01），填写为"+8675528****01"。

calleeNum

否

String(4-31)

将B号码修改为新的值。

填写为全局号码格式。

• 手机号码格式为国家码（如+86）+手机号码（11位数字的手机号码，如138****0001），填写为"+86138****0001"。

• 固话号码为国家码（如+86）+不带前置0的区号（如755）+本地固话号码（7或8位数字的固话号码，以实际号码为准，如28****01），填写为"+8675528****01"。

callDirection

否

Integer

表示修改后的绑定关系允许的呼叫方向，取值范围：

• 0：bidirectional，表示callerNum和calleeNum都可以通过X号码呼叫对方。
• 1：caller to callee，表示只允许callerNum通过X号码呼叫calleeNum。
• 2：callee to caller，表示只允许calleeNum通过X号码呼叫callerNum。

不携带该参数表示不修改呼叫方向。

duration

否

Integer

更新绑定关系保持时间，单位为秒，从修改绑定关系成功开始计算。

取值范围：0~7776000（90天）

不携带该参数表示不修改绑定关系保持时间。

preVoice

否

ApiPlayInfo

修改个性化通话前等待音。

不携带该参数表示不修改通话前等待音。

maxDuration

否

Integer

修改允许单次通话进行的最长时间，单位为分钟。

取值范围：0~1440

• 0：系统不主动结束通话，由主被叫双方结束通话。
• 1~1440：当通话时长达到此配置值，系统主动结束通话。

不携带时，表示不修改该参数值。

lastMinVoice

否

String(0-128)

该绑定关系的maxDuration不为0时该参数有效。

修改通话剩余最后一分钟时的提示音，填写为放音文件名，可在放音文件管理页面查看。

不携带时，表示不修改该参数值。

privateSms

否

String(枚举)

修改该绑定关系是否支持短信功能。

若客户添加应用时未开通短信功能，请勿携带此参数。

取值范围：

• false：不支持短信
• true：支持短信

不携带时，表示不修改该参数值。

recordFlag

否

String(枚举)

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

• false：表示不录音
• true：表示录音。

该参数仅当客户添加应用时申请开通了录音功能才有效。

不携带时，表示不修改该参数值。

userData

否

String(1-256)

用户自定义数据。

• 不允许携带以下字符：“^”，“{”，“}”。
• 不允许包含中文字符，如果包含中文字符请采用Base64编码。

callerHintTone

否

String(0-128)

修改callerNum的通话前等待音，填写为放音文件名，可在放音文件管理页面查看。

不携带时，表示不修改该参数值。

calleeHintTone

否

String(0-128)

修改calleeNum的通话前等待音，填写为放音文件名，可在放音文件管理页面查看。

不携带时，表示不修改该参数值。

resultcode

是

String(1-32)

请求返回的结果码。

resultdesc

是

String(1-256)

操作结果描述。

200

0

Success.

成功。

-

400

1023006

Authorization not contained in the HTTP header.

HTTP消息头未找到Authorization字段。

请检查HTTP消息头中是否携带了Authorization字段。

1023007

realm not contained in Authorization.

Authorization字段中未找到realm属性。

请检查Authorization字段中的是否携带了realm属性。

1023008

profile not contained in Authorization.

Authorization字段中未找到profile属性。

请检查Authorization字段中的是否携带了profile属性。

1023009

The value of realm in Authorization must be SDP.

Authorization中realm属性值应该为“SDP”。

请检查Authorization字段中的realm属性值是否为“SDP”。

1023010

The value of profile in Authorization must be UsernameToken.

Authorization中profile属性值应该为“UsernameToken”。

请检查Authorization字段中的profile属性值是否为“UsernameToken”。

1023011

The value of type in Authorization must be app_key.

Authorization中type属性值应该为“Appkey”。

请检查Authorization字段中的type属性值是否为“Appkey”。

1023012

type not contained in Authorization.

Authorization字段中未找到type属性。

请检查Authorization字段中是否携带了type属性。

1023033

HTTP header not found X-AKSK field.

HTTP头未找到X-AKSK字段。

请检查HTTP消息头中是否携带了X-AKSK字段。

1023034

UserName not contained in X-AKSK.

X-AKSK字段中未找到UserName属性。

请检查X-AKSK字段中的是否携带了Username属性。

1023035

Nonce not contained in X-AKSK.

X-AKSK字段中未找到Nonce属性。

请检查X-AKSK字段中的是否携带了Nonce属性。

1023036

Created not contained in X-AKSK.

X-AKSK字段中未找到Created属性。

请检查X-AKSK字段中的是否携带了Created属性。

1023037

PasswordDigest not contained in X-AKSK.

X-AKSK字段中未找到PasswordDigest属性。

请检查X-AKSK字段中的是否携带了PasswordDigest属性。

1023038

UsernameToken not contained in X-AKSK.

X-AKSK中没有携带UsernameToken。

请检查X-AKSK字段中的是否携带了UsernameToken属性。

401

1010010

Invalid digest.

PasswordDigest校验失败。

请检查PasswordDigest字段填写是否正确。

1010013

Time out limit.

时间超出限制。

请确认X-AKSK鉴权时，生成随机数的时间与发送请求时的本地时间不能相差太大（具体差值请与管理员确认）。

403

1010002

Invalid request.

无效请求。

参考各接口参数说明，检查请求携带的参数格式是否正确，如以下参数格式问题：

• 绑定接口填写的号码参数需为全局号码格式，如+86138****0001或+8675528****01；
• 放音文件需上传通过审核才可通过接口调用，点击查看如何上传审核。
• 参考接口参数说明，检查是否携带了不能同时携带的参数；
• 参数长度或格式是否错误。

1010003

Invalid app_key.

无效的app_key。

请检查请求携带的app_key填写是否正确。

1010004

The status of the app_key is unavailable.

app_key状态异常。

请检查请求携带的app_key所属应用状态是否正常。

1010010

The flow control upper limit is reached on the platform.

平台达到系统流控上限。

请稍等一分钟后再试。

1010029

The subscriber status is frozen.

用户账号已冻结。

• 查看账户是否欠费。如欠费需充值后才能继续使用。
• 若未欠费，请联系华为云客服处理。

1010040

The app_key is not allowed to invoke the API.

app_key没有调用本API的权限。

调用的接口和app_key所属的应用模式不一致。如添加应用时选择的AXB模式的应用，调用接口时只能调用AXB模式的接口，不能调用其他模式的接口。

1012007

The record does not exist.

记录不存在。

未查询到绑定关系，请检查携带的subscriptionId参数是否填写正确，或是否属于该应用。

1012102

The number status is abnormal.

号码状态异常。

出现该错误码表示调用接口时指定的X号码因投诉或号码状态异常被隐私保护通话平台加入了黑名单，请查看订购号码时填写的邮箱是否有业务下线通知邮件，如果没有，请拨打400电话联系华为云客服处理。

1012010

The number $ has been bound.

绑定关系已存在。

请检查callerNum或calleeNum是否已和subscriptionId指定的X号码存在绑定关系，且绑定关系未过期，然后修改callerNum/calleeNum的值。

1020166

The app client ip is not in ip white list.

对端app IP不在白名单列表中。

联系管理员检查IP白名单是否配置正确。

1020176

Authentication failed, try again later

鉴权失败，稍后重试

IP因鉴权失败次数过多导致被拉黑，请30分钟后重试，或联系管理员放通该IP。

1020179

Application does not enable sms function.

应用未开启短信功能。

请确认app_key所属的应用是否开启了短信功能，点击查看如何开启短信功能。

500

1010001

Internal system error.

系统错误。

请联系客服处理。

1023001

Internal error.

内部错误。

1023002

Response timeout.

响应超时。

重新发送一次请求，若依然返回响应超时，请联系管理员处理。