AXB模式绑定次数查询接口 - QueryAXBBindingCount

接口功能

该接口用于客户向隐私保护通话平台查询隐私号码的绑定次数，支持单条数据查询和基于游标的分页查询。

请求方向

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限管理。

URI

GET /rest/caas/virtualnumber/v1.0

请求参数

表1 请求URL参数说明
参数名称	是否必选	参数类型	说明
number	否	String	X号码，查询该号码的绑定次数；携带为全局号码格式（包含国家码），并需要把号码中的+号转义为%2B，如：%2B86138****0021。
cursor	否	String	上一次请求返回的nextCursor值，首次请求默认为0。取值范围：1~20位的正整数当携带了number时，该参数不生效，无需关注该参数。
limit	否	Integer	查询数量，即每次查询最多返回多少条数据。取值范围：1~100，默认为50 当携带了number时，该参数不生效，无需关注该参数。

表2 请求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。不同编程语言中的时间格式转换方式不同，部分语言可参表3。

表3 不同编程语言的时间格式
编程语言	时间格式
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()转换后的时间格式去除毫秒后即为本接口要求的时间格式。

响应参数

表4 响应结果参数
参数名称	参数类型	说明
resultcode	String	请求返回的结果码。
resultdesc	String	操作结果描述。
nextCursor	String	指向下一次请求的游标值cursor，分页查询场景下返回。
limit	Integer	查询的分页大小，分页查询场景下返回。
bindTimesList	List<BindTimes>	X号码绑定次数列表。

表5 BindTimes定义
参数名称	参数类型	说明
areaCode	String	地域编码。
number	String	X号码。
numStatus	Integer	号码状态。 5：正常 9：暂停 10：不可用 11：冻结绑定各号码状态对业务的影响如下：正常：无影响。暂停&不可用：绑定、呼叫和短信都不可用。冻结绑定：号码不可新增绑定关系，但已存在的绑定关系的呼叫和短信业务不受影响。
alreadyBinds	Integer	号码已绑定次数。
remainBinds	Integer	号码剩余绑定次数。

结果码说明

表6 响应结果码
响应码	结果码	英文描述	中文描述	处理方法
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字段填写是否正确。
401	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.	平台达到系统流控上限。	请稍等一分钟后再试。
	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白名单是否配置正确。
	1020176	Authentication failed, try again later	鉴权失败，稍后重试	IP因鉴权失败次数过多导致被拉黑，请30分钟后重试，或联系管理员放通该IP。
500	1010001	Internal system error.	系统错误。	请联系管理员处理。
	1023001	Internal error.	内部错误。	请联系管理员处理。
	1023002	Response timeout.	响应超时。	重新发送一次请求，若依然返回响应超时，请联系管理员处理。

接口示例

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

请求示例1：分页查询本应用下所有X号码绑定次数

GET /rest/caas/virtualnumber/v1.0?cursor=100&limit=2 HTTP1.1

content-type: application/json;charset=UTF-8
authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"
x-AKSK: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="NDA1MWIwNjI2ZTkyNWFlM2FhMTE5NDE1YTk5NjU1YWE4NjNlZTY1MmRhYzkxZGViNzczZjdjMjkzZWQ4ZjAwNA==",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2025-05-13T00:35:30Z"

响应示例

HTTP/1.1 200 OK

Content-Type: application/json;charset=utf-8
Content-Length: xx

{
    "resultcode": "0",
    "resultdesc": "Success",
    "nextCursor": "354",
    "limit": 2,
    "bindTimesList": [
        {
            "areaCode":"029",
            "number":"+8613888888888",
            "numStatus": 5,
            "alreadyBinds":1,
            "remainBinds":9999,
        },
        {
            "areaCode":"029",
            "number":"+8613888888880",
            "numStatus": 5,
            "alreadyBinds":100,
            "remainBinds":9900,
        }
    ]
}

请求示例2：查询单个X号码的绑定次数

GET /rest/caas/virtualnumber/v1.0?number=%2B8613888888888 HTTP1.1

content-type: application/json;charset=UTF-8
authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey"
x-AKSK: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="NDA1MWIwNjI2ZTkyNWFlM2FhMTE5NDE1YTk5NjU1YWE4NjNlZTY1MmRhYzkxZGViNzczZjdjMjkzZWQ4ZjAwNA==",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2025-05-13T00:35:30Z"

响应示例

HTTP/1.1 200 OK

Content-Type: application/json;charset=utf-8
Content-Length: xx

{
    "resultcode": "0",
    "resultdesc": "Success",
    "bindTimesList": [
        {
            "areaCode":"029",
            "number":"+8613888888888",
            "numStatus": 5,
            "alreadyBinds":1,
            "remainBinds":9999,
        }
    ]
}

父主题：AXB模式

上一篇：短信通知接口

下一篇：AXE模式