AI 助理
备案控制台
文档
输入文档关键字查找
首页 号码隐私保护 开发参考 API参考 API目录 查询号码绑定 QuerySubscriptionDetail - 查询号码绑定详情

QuerySubscriptionDetail - 查询号码绑定详情

更新时间：
产品详情
我的收藏

查询号码的绑定详情。获取号码绑定关系状态、分机号码、是否录音、ASR状态等信息。

接口说明

查询前，建议您先明确需查询的隐私号码，即 X 号码，且该号码有绑定关系。

QPS 限制

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

PoolKey 和 ProductType 限制

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

调试

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

授权信息

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

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

请求参数

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

号码池 Key。

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

说明 当 ProductType 为空时必填。
FC10000012345****
ProductTypestring否

产品类型。取值：

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

    绑定关系 ID。

    请登录号码隐私保护控制台，在号码管理页面筛选号码，点击详情查看号码的绑定关系 ID，或者在调用 BindAxb 等号码绑定 API 时查看返回参数中的 SubsId。

    说明 在填写绑定关系 ID 时，注意填写与 PhoneNoX 参数关联的绑定关系 ID。
    		100000076879****
    PhoneNoXstring是

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

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

    说明 在填写 X 号码时，注意填写与 SubsId 参数关联的 X 号码。
    		139****1111

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Codestring

    请求状态码。

    		OK
    Messagestring

    状态码的描述。

    		OK
    RequestIdstring

    请求 ID。

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

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

    Statuslong

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

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

    AXG 分机号中的分机号码。

    		130
    PhoneNoBstring

    绑定关系中的 B 号码。

    		138****0000
    GroupIdlong

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

    		200001234****
    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 号码。

    		139****1111
    CallRestrictstring

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

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

    ASR 模型 ID。取值：

    • 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac

    • 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77

    • 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b

    		7ee372834d2f4cc7ac0d0ab2d0ae1aac
    PhoneNoAstring

    绑定关系中的 A 号码。

    		139****0000

    示例

    正常返回示例

    JSON格式

    {
  "Code": "OK",
  "Message": "OK",
  "RequestId": "066E6E47-04CB-4774-A976-4F73CB76D4A3",
  "SecretBindDetailDTO": {
    "Status": 1,
    "Extension": "130",
    "PhoneNoB": "138****0000",
    "GroupId": 0,
    "NeedRecord": true,
    "ASRStatus": true,
    "GmtCreate": "2019-03-05 12:00:00",
    "ExpireDate": "2019-09-05 12:00:00",
    "SubsId": "100000076879****",
    "PhoneNoX": "139****1111",
    "CallRestrict": "CONTROL_BX_DISABLE ",
    "ASRModelId": "7ee372834d2f4cc7ac0d0ab2d0ae1aac",
    "PhoneNoA": "139****0000"
  }
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-03-16API 内部配置变更，不影响调用查看变更详情
    上一篇：查询号码绑定下一篇：QuerySubsId - 查询号码绑定ID
    文档推荐