文档

QuerySubscriptionDetail - 查询号码的绑定关系

更新时间:

查询号码的绑定关系。

接口说明

QPS 限制

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

PoolKey 和 ProductType 限制

PoolKey 和 ProductType 参数请至少填写一个,若两个参数都不填,调用接口时会报错。 建议原大于用户填 ProductType 参数,阿里云用户填 PoolKey 参数。

调试

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

授权信息

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

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

请求参数

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

号码池 Key。请登录号码隐私保护控制台,在号码池管理中查看号码池 Key。

说明 ProductType 为空时必填。
FC123456
ProductTypestring

产品类型。取值:

  • AXB_170
  • AXN_170
  • AXN_95
  • AXN_EXTENSION_REUSE
说明
  • 适用于原阿里大于客户,阿里云用户可忽略。
  • PoolKey 为空时必填。
  • AXB_170
    SubsIdstring

    绑定关系 ID。

    可以在控制台的号码管理 > 号码详情中查看绑定关系 ID,或者在调用 BindAxb 等号码绑定 API 时查看返回参数中的 SubsId

    100000076879****
    PhoneNoXstring

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

    13900001234

    返回参数

    名称类型描述示例值
    object
    Codestring

    请求状态码。

    OK
    Messagestring

    状态码的描述。

    OK
    RequestIdstring

    请求 ID。

    066E6E47-04CB-4774-A976-4F73CB76D4A3
    SecretBindDetailDTOobject

    接口调用成功后返回的结构体。

    Statuslong

    该绑定关系的状态。取值:

    • 0:已失效。
    • 1:生效中。
    1
    Extensionstring

    AXG 分机号中的分机号码。

    130
    PhoneNoBstring

    绑定关系中的 B 号码。

    13900002222
    GroupIdlong

    绑定关系中的 G 号码组 ID,即 GID。

    2000000130001
    NeedRecordboolean

    是否对该绑定关系产生的所有通话,进行通话录音。取值:

    • false:不录音
    • true:录音
    true
    ASRStatusboolean

    ASR 状态。取值:

    • false:关闭
    • true:开启
    true
    GmtCreatestring

    绑定关系的创建时间。

    2019-03-05 12:00:00
    ExpireDatestring

    绑定关系的过期时间。

    2019-09-05 12:00:00
    SubsIdstring

    绑定关系 ID。

    100000076879****
    PhoneNoXstring

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

    13900001234
    CallRestrictstring

    单通呼叫限制的状态。如果没有设置单通呼叫限制,则不返回该参数。取值:

    • CONTROL_AX_DISABLE:A 号码无法呼叫 X 号码。
    • CONTROL_BX_DISABLE:B 号码无法呼叫 X 号码。
    CONTROL_BX_DISABLE
    ASRModelIdstring

    ASR 模型 ID。

    123456
    PhoneNoAstring

    绑定关系中的 A 号码。

    13900001111

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "Message": "OK",
      "RequestId": "066E6E47-04CB-4774-A976-4F73CB76D4A3",
      "SecretBindDetailDTO": {
        "Status": 1,
        "Extension": "130",
        "PhoneNoB": "13900002222",
        "GroupId": 2000000130001,
        "NeedRecord": true,
        "ASRStatus": true,
        "GmtCreate": "2019-03-05 12:00:00",
        "ExpireDate": "2019-09-05 12:00:00",
        "SubsId": "100000076879****",
        "PhoneNoX": "13900001234",
        "CallRestrict": "CONTROL_BX_DISABLE ",
        "ASRModelId": "123456",
        "PhoneNoA": "13900001111"
      }
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-03-16API 内部配置变更,不影响调用看变更集
    变更项变更内容
    API 内部配置变更,不影响调用
    • 本页导读 (1)
    文档反馈