隐私保护通话 PrivateNumber-AXYB模式绑定信息查询接口:请求参数

时间:2023-11-01 16:16:20

请求参数

表2 请求URL参数说明

参数名称

是否必选

参数类型

说明

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能力标识,登录控制台,从“应用管理”页获取。

表3 请求Headers参数说明

参数名称

是否必选

参数类型

说明

Content-Type

String

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

Authorization

String

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

X-AKSK

String

取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。
  • PasswordDigest:根据PasswordDigest = Base64 (HMAC-SHA256 (Password,Nonce + Created))生成。其中,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()转换后的时间格式去除毫秒后即为本接口要求的时间格式。

support.huaweicloud.com/api-PrivateNumber/privatenumber_axyb_0019.html