概述
摩盖云通信AXB号码隐私保护服务,查询号码的绑定关系。
请求URL
http://api-hub.mobilegate.net/CloudComm/querySubscriptionDetail
请求方式
POST
请求参数
参数名 |
备注 |
enterpriseId
|
企业账号ID(详见管理控制台->开发信息) |
poolKey
|
号码池 Key |
subsId
|
绑定关系 ID。在调用 BindAxb 等号码绑定 API 或QuerySubsId API时查看返回参数中的 SubsId。 |
phoneNoX
|
绑定关系中的隐私号码,即 X 号码。 |
requestToken
|
签名(详见 参数签名) |
请求包体示例
POST http(s)://api-hub.mobilegate.net/CloudComm/querySubscriptionDetail HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: length
enterpriseId=string&poolKey=string&subsId=string&phoneNoX=string&requestToken=string
返回结果
参数名 |
备注 |
Code
|
请求状态码。返回 OK 代表请求成功。其他错误码,请参见业务错误码列表。 |
Message
|
状态码的描述。 |
RequestId
|
请求 ID。 |
[+] SecretBindDetailDTO
|
接口调用成功后返回的结构体。 |
[-] Status
|
该绑定关系的状态。取值:0:已失效。1:生效中。 |
[-] Extension
|
分机号码。 |
[-] PhoneNoB
|
绑定关系中的 B 号码。 |
[-] GroupId
|
在AXG模式下,绑定关系中的 G 号码组 ID,即 GID。 |
[-] NeedRecord
|
是否对该绑定关系产生的所有通话,进行通话录音。取值:false:不录音 / true:录音 |
[-] ASRStatus
|
ASR 状态。取值:false:关闭 / true:开启 |
[-] GmtCreate
|
绑定关系的创建时间。 |
[-] ExpireDate
|
绑定关系的过期时间。 |
[-] SubsId
|
绑定关系 ID。 |
[-] PhoneNoX
|
绑定关系中的隐私号码,即 X 号码。 |
[-] CallRestrict
|
单通呼叫限制的状态。如果没有设置单通呼叫限制,则不返回该参数。取值:CONTROL_AX_DISABLE:A 号码无法呼叫 X 号码。CONTROL_BX_DISABLE:B 号码无法呼叫 X 号码。 |
[-] ASRModelId
|
ASR 模型 ID。 |
[-] PhoneNoA
|
绑定关系中的 A 号码。 |
返回格式
JSON
返回示例
{
"Results": {
"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"
}
}
}
请求异常返回
输入参数错误
{"Result": "-1"}
参数含有非法字符
{"Result": "-2"}
enterpriseID未提供
{"Result": "-3"}
参数签名错误
{"Result": "-99"}