概述
摩盖云通信AXB号码隐私保护服务,增加AXB号码绑定关系。
请求URL
http://api-hub.mobilegate.net/CloudComm/bindAXB
请求方式
POST
请求参数
参数名 |
备注 |
enterpriseId
|
企业账号ID(详见管理控制台->开发信息) |
poolKey
|
号码池 Key |
phoneNoA
|
AXB 中的 A 号码。A 号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符。 |
phoneNoB
|
AXB 中的 B 号码,A 号码拨打 X 号码时会转接到 B 号码。 B 号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符。 |
phoneNoX
|
AXB 中的 X 号码。X 号码是您绑定号码前在号码隐私保护控制台购买的电话号码,用于转接电话。如果未指定 X 号码,将根据参数 ExpectCity 从指定号码池中随机指定一个号码作为 X 号码。 |
expiration
|
绑定关系的过期时间。示例 2023-07-07 12:00:00 |
expectCity
|
指定城市进行 X 号码的选号。如果当前号码池中没有该城市的可用号码,或未指定此参数,将从当前号码池中随机分配一个其他城市的号码作为 X 号码。 |
isRecordingEnabled
|
是否需要针对该绑定关系产生的所有通话进行通话录音。取值:true:录音。false:不录音(默认值)。 |
outId
|
外部业务扩展字段,通话记录回执消息中会回传此参数。 |
callRestrict
|
单通呼叫限制的状态。取值:CONTROL_AX_DISABLE:A 号码无法呼叫 X 号码。CONTROL_BX_DISABLE:B 号码无法呼叫 X 号码。 |
requestToken
|
签名(详见 参数签名) |
请求包体示例
POST http(s)://api-hub.mobilegate.net/CloudComm/bindAXB HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: length
enterpriseId=string&poolKey=string&phoneNoA=string&phoneNoB=string&phoneNoX=string&expiration=string&expectCity=string&isRecordingEnabled=string&outId=string&callRestrict=string&requestToken=string
返回结果
参数名 |
备注 |
Code
|
请求状态码。返回 OK 代表请求成功。其他错误码,请参见业务错误码列表。 |
Message
|
状态码的描述。 |
RequestId
|
请求 ID。 |
[+] SecretBindDTO
|
号码绑定成功后返回的结构体。 |
[-] Extension
|
分机号码。接口 BindAxb 不涉及分机号码,请忽略该返回参数。 |
[-] SecretNo
|
隐私号码,即 X 号码。 |
[-] SubsId
|
绑定关系 ID。 |
返回格式
JSON
返回示例
{
"Results": {
"Code": "OK",
"Message": "OK",
"RequestId": "E78AE403-432F-5E57-BA5F-720DC8679247",
"SecretBindDTO": {
"Extension": "13764923703",
"SecretNo": "17187401909",
"SubsId": "1000167450534910"
}
}
}
请求异常返回
输入参数错误
{"Result": "-1"}
参数含有非法字符
{"Result": "-2"}
enterpriseID未提供
{"Result": "-3"}
参数签名错误
{"Result": "-99"}