文档首页 > > API参考> AXB模式> AXB模式绑定信息查询接口

AXB模式绑定信息查询接口

分享
更新时间: 2019/11/27 GMT+08:00

接口功能

该接口用于客户向隐私保护通话平台查询已设置的AXB绑定关系的相关信息。

请求方向

客户应用(客户端) → 隐私保护通话平台(服务端)

接口类型

表1 请求说明

请求方法

GET

访问URI

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

通信协议

HTTPS

请求参数

表2 请求URL参数说明

参数名称

是否必选

参数类型

说明

relationNum

String(4-31)

指定X号码查询该号码上所有绑定关系。

填写为全局号码格式(包含国家码),并需要把号码中的+号转义为%2B,例如:%2B8613800000021。

该参数与subscriptionId为二选一关系。

同时携带relationNum和subscriptionId时系统以subscriptionId为准。

subscriptionId

String(0-64)

指定“AXB模式绑定接口”返回的绑定ID查询单组绑定关系。

该参数与relationNum为二选一关系。

同时携带relationNum和subscriptionId时系统以subscriptionId为准。

pageIndex

Integer

查询的分页索引,从1开始编号。

该参数需要与pageSize参数配合使用,用于指定本次查询返回第几页的数据。

如果不携带该参数,系统默认该参数为1。

当携带了subscriptionId时无需关注该参数。

pageSize

Integer

查询的分页大小,即每次查询返回多少条数据。

取值范围:10~100

如果不携带pageSize或pageSize不在有效范围内,系统默认该参数为50。

当携带了subscriptionId时无需关注该参数。

表3 请求Headers参数说明

参数名称

是否必选

参数类型

说明

Content-Type

String

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

Authorization

String

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

X-WSSE

String

取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。
  • PasswordDigest:根据PasswordDigest = Base64 (SHA256 (Nonce + Created + Password))生成。其中,Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可,无需包含+号和空格。
  • Nonce:客户发送请求时生成的一个随机数,长度为1~128位,可包含数字和大小写字母。例如:66C92B11FF8A425FB8D4CCFE0ED9ED1F。
  • Created:随机数生成时间。采用标准UTC格式,例如:2018-02-12T15:30:20Z。不同编程语言中的时间格式转换方式不同,部分语言可参考表4
表4 不同编程语言的时间格式

编程语言

时间格式

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

响应参数

表5 响应结果参数

参数名称

是否必选

参数类型

说明

resultcode

String(1-32)

请求返回的结果码。

resultdesc

String(1-256)

操作结果描述。

app_key

String(1-32)

请求中携带的app_key。

成功响应时必定返回。

totalCount

Integer

查询结果的记录总数。

成功响应时必定返回。

pageIndex

Integer

查询的分页索引。

成功响应时必定返回。

pageSize

Integer

查询的分页大小。

成功响应时必定返回。

relationNumList

relationNumInfo[1-100]

X号码绑定关系列表。

成功响应时必定返回。

表6 relationNumInfo定义

参数名称

是否必选

参数类型

说明

subscriptionId

String(1-64)

绑定ID。

成功响应时必定返回。

callerNum

String(1-32)

AXB中的A号码。

携带为全局号码格式(包含国家码),如:+8613800000001。

成功响应时必定返回。

relationNum

String(1-32)

AXB中的X号码。

携带为全局号码格式(包含国家码),如:+8613800000021。

成功响应时必定返回。

calleeNum

String(1-32)

AXB中的B号码。

携带为全局号码格式(包含国家码),如:+8613800000002。

成功响应时必定返回。

recordFlag

Enum

录音标识

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

成功响应时必定返回。

recordHintTone

String(1-128)

录音提示音文件名。

subscribeTime

Datetime

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

成功响应时必定返回。

callDirection

Integer

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

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

成功响应时必定返回。

duration

Integer

绑定关系保持时间,单位为秒,0表示永不过期。

成功响应时必定返回。

preVoice

ApiPlayInfo

通话前等待音文件名。

maxDuration

Integer

允许单次通话进行的最长时间,通话时间从被叫接通的时刻开始计算。

取值范围:0~1440分钟,0表示系统不主动结束通话,由主被叫双方结束通话。

成功响应时必定返回。

lastMinVoice

String(0-128)

通话剩余最后一分钟提示音的文件名。

privateSms

Enum

标识该绑定关系是否支持短信功能。

该参数仅当客户创建应用时开通了短信功能才有效。

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

不携带此参数表示默认支持短信。

表7 ApiPlayInfo定义

参数名称

是否必选

参数类型

说明

callerHintTone

String(0-128)

callerNum的通话前等待音文件名。

calleeHintTone

String(0-128)

calleeNum的通话前等待音文件名。

结果码说明

表8 响应结果码

响应码

结果码

英文描述

中文描述

处理方法

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属性。

1023013

WSSE not contained in Authorization.

Authorization中没有携带WSSE。

请检查Authorization字段中是否携带了WSSE。

1023026

X-WSSE not contained in the HTTP header.

HTTP头未找到X-WSSE字段。

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

1023027

Username not contained in X-WSSE.

X-WSSE字段中未找到Username属性。

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

1023028

Nonce not contained in X-WSSE.

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

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

1023029

Created not contained in X-WSSE.

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

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

1023030

PasswordDigest not contained in X-WSSE.

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

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

1023031

The format of Created is incorrect.

Created属性格式错误。

请检查X-WSSE字段中的Created属性格式是否正确。

1023032

UsernameToken not contained in X-WSSE.

X-WSSE字段中未找到UsernameToken属性。

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

401

1010010

Invalid digest.

PasswordDigest校验失败。

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

1010013

Time out limit.

时间超出限制。

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

403

1010002

Invalid request.

无效请求。

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

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

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.

平台达到系统流控上限。

请稍等一分钟后再试。

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号码是否属于该应用。

1012007

The record does not exist.

记录不存在。

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

1020166

The app client ip is not in ip white list.

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

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

500

1010001

Internal system error.

系统错误。

请联系管理员处理。

1023001

Internal error.

内部错误。

1023002

Response timeout.

响应超时。

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

接口示例

接口示例仅供参考,请以实际消息为准。

  • 请求示例
    GET /rest/caas/relationnumber/partners/v1.0?relationNum=%2B8675528780808&pageIndex=1&pageSize=50  HTTP1.1
     
    content-type:application/json;charset=UTF-8
    authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey"
    x-wsse: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="NDA1MWIwNjI2ZTkyNWFlM2FhMTE5NDE1YTk5NjU1YWE4NjNlZTY1MmRhYzkxZGViNzczZjdjMjkzZWQ4ZjAwNA==",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"
  • 响应示例
    HTTP/1.1 200 OK 
    Content-Type: application/json;charset=utf-8 
    Content-Length: xx 
    
    { 
    "resultcode":"0", 
    "resultdesc":"Success", 
    "app_key":"appkey", 
    "totalCount":1,
    "pageIndex":1,
    "pageSize":50,
    "relationNumList":[{
     "subscriptionId":"efw89efwf7fea324252",
     "callerNum":"+8613800000021", 
     "relationNum":"+8675520000008", 
     "calleeNum":"+8613800000023", 
     "subscribeTime":"2016-12-24 15:15:15", 
     "callDirection":1,
     "duration":6000
     "maxDuration":10
    }]
    }
分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区