AXYB模式绑定信息查询接口

GET

/rest/omp/xyrelationnumber/v1.0

HTTPS

relationNum

否

String(1-32)

想要查询绑定关系的X号码，填写为调用“AXYB模式绑定接口”绑定AX时返回的绑定relationNumber。

填写为全局号码格式（包含国家码），并需要把号码中的+号转义为%2B。

例如：%2B86138****0021。

• 该参数与subscriptionId为二选一关系，只携带relationNum时表示查询该隐私号码上绑定的所有关系。
• 同时携带relationNum和subscriptionId时系统以subscriptionId为准。

subscriptionId

否

String(1-64)

填写为调用“AXYB模式绑定接口”接口时返回的绑定ID。

• 该参数与relationNum为二选一关系，携带subscriptionId时表示查询subscriptionId指定的所有绑定关系。
• 同时携带relationNum和subscriptionId时系统以subscriptionId为准。

app_key

是

String(1-128)

AXYB能力标识，登录控制台，从“应用管理”页获取。

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()转换后的时间格式去除毫秒后即为本接口要求的时间格式。

resultcode

是

String(1-32)

请求返回的结果码。

resultdesc

是

String(1-256)

操作结果描述。

xyRelationNumList

否

xyRelationNumInfo[1-5]

隐私号码绑定关系列表。

成功响应时必定返回。

bindId

否

String(1-64)

绑定Id，由隐私保护通话平台自动分配。

numA

否

String(1-32)

与指定的隐私号码X绑定的用户A号码，携带为全局号码格式（包含国家码），如：+86138****0001或+8675528****02。

numX

否

String(1-32)

请求中指定的隐私号码X，携带为全局号码格式（包含国家码），如：+86138****0021。

numY

否

String(1-32)

分配的隐私号码Y，携带为全局号码格式（包含国家码），如：+86138****0022。

numB

否

String(1-32)

与隐私号码Y绑定的用户B号码，携带为全局号码格式（包含国家码），如：+86138****0002或+8675528****01。

recordFlag

否

String(枚举)

录音标识

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

recordHintTone

否

String(1-128)

录音提示音文件名。

查询成功且SP调用“AXYB模式绑定接口”时指定了录音提示音文件，才会携带该参数。

subscribeTime

否

Datetime

设置或者最近一次修改该绑定关系的时间，例如2016-12-24 15:15:15。

callDirection

否

Integer

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

• 0：bidirectional，双向，表示A和B/C都可以通过X或Y呼叫对方。
• 1：A to B，表示只允许A通过Y呼叫B/C。
• 2：B to A，表示只允许B/C通过X呼叫A。

duration

否

String(1-32)

绑定关系保持时间，单位为秒。

取值范围：

• 0：绑定关系永不过期。
• 60~7776000(90天)：绑定关系过期后会被系统自动解除。

ybDuration

否

String(1-32)

YB绑定关系保持时间，单位为秒。

取值范围：

• 0：YB的绑定关系随AX解绑时解绑。
• 60~7776000(90天)：绑定关系过期后会被系统自动解除。

preVoiceX

否

String(1-128)

X的预放音文件名

preVoiceY

否

String(1-128)

Y的预放音文件名

userData

否

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；
• 放音文件需上传通过审核才可通过接口调用，点击查看如何上传审核。
• 参考接口参数说明，检查是否携带了不能同时携带的参数，如AXE模式绑定接口不能同时携带callbackTone和callbackNum，若是，请保留一个；
• 参数长度或格式是否错误，如AXE模式分机号长度或timeUnit的格式是否正确。

1010003

Invalid app_key.

无效的app_key。

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

1010008

The status of the app_key is unavailable.

app_key状态异常。

请联系管理员确认该app_key状态是否正常。

1010029

The subscriber status is frozen.

用户账号已冻结。

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

1010040

The app_key is not allowed to invoke the API.

app_key没有调用本API的权限。

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

1012001

Resource of number is not to be applied.

资源未申请

携带的app_key和X号码没有绑定关系，请检查携带的X号码是否属于该应用。

1016001

The record does not exist.

记录不存在。

未查询到绑定关系，请检查relationNum或subscriptionId参数的填写是否正确。

1020166

The app client ip is not in ip white list.

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

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

1020176

Authentication failed, try again later

鉴权失败，稍后重试

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

500

1010001

Internal system error.

系统错误。

请联系管理员处理。

1023001

Internal error.

内部错误。

1023002

Response timeout.

响应超时。

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