调用QuerySubscriptionDetail接口查询号码的绑定关系。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String QuerySubscriptionDetail

系统规定参数。取值:QuerySubscriptionDetail

PoolKey String FC123456

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

ProductType String AXB_170

产品类型。

说明 适用于原阿里大于客户,阿里云用户可忽略。
SubsId String 100000076879****

绑定关系ID。

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

PhoneNoX String 13900001234

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

返回数据

名称 类型 示例值 描述
Code String OK

请求状态码。

Message String OK

状态码的描述。

RequestId String 066E6E47-04CB-4774-A976-4F73CB76D4A3

请求ID。

SecretBindDetailDTO Object

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

Status Long 1

该绑定关系的状态。

取值:

  • 0:已失效。
  • 1:生效中。
Extension String 130

AXG分机号中的分机号码。

PhoneNoB String 13900002222

绑定关系中的B号码。

GroupId Long 2000000130001

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

NeedRecord Boolean true

是否设置了对该绑定关系产生的所有通话录制通话录音。

ASRStatus Boolean true

ASR状态。取值:

  • False:关闭
  • True:开启
GmtCreate String 2019-03-05 12:00:00

绑定关系的创建时间。

ExpireDate String 2019-09-05 12:00:00

绑定关系的过期时间。

SubsId String 100000076879****

绑定关系ID。

PhoneNoX String 13900001234

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

CallRestrict String CONTROL_BX_DISABLE

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

取值:

  • CONTROL_AX_DISABLE:A号码无法呼叫X号码。
  • CONTROL_BX_DISABLE:B号码无法呼叫X号码。
ASRModelId String 123456

ASR模型ID。

PhoneNoA String 13900001111

绑定关系中的A号码。

示例

请求示例

https://dyplsapi.aliyuncs.com/?Action=QuerySubscriptionDetail
&PoolKey=FC123456
&ProductType=AXB_170
&SubsId=100000076879****
&PhoneNoX=13900001234
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
  }
}

错误码

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