查询号码的绑定详情。获取号码绑定关系状态、分机号码、是否录音、ASR状态等信息。
接口说明
查询前，建议您先明确需查询的隐私号码，即 X 号码，且该号码有绑定关系。
QPS 限制
本接口的单用户 QPS 限制为 1000 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
PoolKey 和 ProductType 限制
PoolKey 和 ProductType 参数请至少填写一个，若两个参数都不填，调用接口时会报错。 建议原阿里大于用户填 ProductType 参数，阿里云用户填 PoolKey 参数。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dypls:QuerySubscriptionDetail |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PoolKey |
string |
否 |
号码池 Key。 在号码隐私保护控制台，号码池管理页面获取号码池 Key。 说明
当 ProductType 为空时必填。 |
FC10000012345**** |
| ProductType |
string |
否 |
产品类型。取值：
说明
|
AXB_170 |
| SubsId |
string |
是 |
绑定关系 ID。 请登录号码隐私保护控制台，在号码管理页面筛选号码，点击详情查看号码的绑定关系 ID，或者在调用 BindAxb 等号码绑定 API 时查看返回参数中的 SubsId。 说明
在填写绑定关系 ID 时，注意填写与 PhoneNoX 参数关联的绑定关系 ID。 |
100000076879**** |
| PhoneNoX |
string |
是 |
绑定关系中的隐私号码，即 X 号码。 请登录号码隐私保护控制台，在号码管理页面获取 X 号码，或者在调用 BindAxb 等号码绑定接口时查看返回参数中的 SecretNo。 说明
在填写 X 号码时，注意填写与 SubsId 参数关联的 X 号码。 |
139****1111 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| Code |
string |
请求状态码。
|
OK |
| Message |
string |
状态码的描述。 |
OK |
| RequestId |
string |
请求 ID。 |
066E6E47-04CB-4774-A976-4F73CB76D4A3 |
| SecretBindDetailDTO |
object |
接口调用成功后返回的结构体。 |
|
| Status |
integer |
该绑定关系的状态。取值：
|
1 |
| Extension |
string |
AXG 分机号中的分机号码。 |
130 |
| PhoneNoB |
string |
绑定关系中的 B 号码。 |
138****0000 |
| GroupId |
integer |
绑定关系中的 G 号码组 ID，即 GID。 |
200001234**** |
| NeedRecord |
boolean |
是否对该绑定关系产生的所有通话，进行通话录音。取值：
|
true |
| ASRStatus |
boolean |
ASR 状态。取值：
|
true |
| GmtCreate |
string |
绑定关系的创建时间。 |
2019-03-05 12:00:00 |
| ExpireDate |
string |
绑定关系的过期时间，格式为 YYYY-MM-DD HH:mm:ss。 |
2019-09-05 12:00:00 |
| SubsId |
string |
绑定关系 ID。 |
100000076879**** |
| PhoneNoX |
string |
绑定关系中的隐私号码，即 X 号码。 |
139****1111 |
| CallRestrict |
string |
单通呼叫限制的状态。如果没有设置单通呼叫限制，则不返回该参数。取值：
|
CONTROL_BX_DISABLE |
| ASRModelId |
string |
ASR 模型 ID。取值：
|
7ee372834d2f4cc7ac0d0ab2d0ae1aac |
| PhoneNoA |
string |
绑定关系中的 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"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。