文档

QuerySubsId - 查询号码绑定ID

更新时间:

查询绑定关系的唯一标识SubsId。

接口说明

  • 支持根据 X 号码查询绑定关系的唯一标识 SubsId。
  • 查询前,建议您先明确需查询的隐私号码,即 X 号码。
  • 在 AXB 中间号、AXN 分机号场景中,同一个 X 号码可能存在多组绑定关系,查询结果会为多条,若 X 号码无绑定关系,查询结果会为空字符串。

QPS 限制

本接口的单用户 QPS 限制为 1000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dypls:QuerySubsIdRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PoolKeystring

号码池 Key。

在号码隐私保护控制台,号码池管理页面获取号码池 Key

FC10000012345****
PhoneNoXstring

绑定关系中的隐私号码,即 X 号码。

请登录号码隐私保护控制台,在号码管理页面获取 X 号码,或者在调用 BindAxb 等号码绑定接口时查看返回参数中的 SecretNo

139****1111

返回参数

名称类型描述示例值
object

返回数据。

Codestring

请求状态码。返回 OK 代表请求成功。

OK
Messagestring

状态码的描述。

OK
RequestIdstring

请求 ID。

E7F99446-8191-43C0-99B5-F58A6AEAD779
SubsIdstring

绑定关系 ID。

11111111****

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "E7F99446-8191-43C0-99B5-F58A6AEAD779",
  "SubsId": "11111111****"
}

错误码

HTTP status code错误码错误信息
400POOLKEY_NOT_EXISTpoolKey not exsit.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-16OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400