查询绑定关系的唯一标识SubsId。
接口说明
支持根据 X 号码查询绑定关系的唯一标识 SubsId。
查询前,建议您先明确需查询的隐私号码,即 X 号码。
在 AXB 中间号、AXN 分机号场景中,同一个 X 号码可能存在多组绑定关系,查询结果会为多条,若 X 号码无绑定关系,查询结果会为空字符串。
QPS 限制
本接口的单用户 QPS 限制为 1000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dypls:QuerySubsId |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PoolKey |
string |
否 |
号码池 Key。 在号码隐私保护控制台,号码池管理页面获取号码池 Key。 |
FC10000012345**** |
| PhoneNoX |
string |
是 |
绑定关系中的隐私号码,即 X 号码。 请登录号码隐私保护控制台,在号码管理页面获取 X 号码,或者在调用 BindAxb 等号码绑定接口时查看返回参数中的 SecretNo。 |
139****1111 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| Code |
string |
请求状态码。返回 OK 代表请求成功。 |
OK |
| Message |
string |
状态码的描述。 |
OK |
| RequestId |
string |
请求 ID。 |
E7F99446-8191-43C0-99B5-F58A6AEAD779 |
| SubsId |
string |
绑定关系 ID。若隐私号码存在多个绑定关系时,会返回多个 SubsId。 |
1000******,1000******,1000****** |
示例
正常返回示例
JSON格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "E7F99446-8191-43C0-99B5-F58A6AEAD779",
"SubsId": "1000******,1000******,1000******"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | POOLKEY_NOT_EXIST | poolKey not exsit. | 号池key不存在 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。