AX&AXB绑定(平台选号)接口,支持进行AX绑定、AXB绑定;且不需要指定X号码,平台根据绑定时指定的城市进行选号。
当需要进行AX绑定时,不设置B号码;
当需要进行AXB绑定时,需设置B号码;
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | SelectNumberAndBindAXB | 要执行的操作,取值:SelectNumberAndBindAXB。 |
Version | String | 是 | 2022-01-01 | API的版本,取值:2022-01-01。 |
CityCodeByPhoneNo | String | 否 | A | 不指定城市时,根据a号码或者b号码获取城市(默认根据a号码) |
OutId | String | 否 | abcdef | 外部业务id |
DegradeCityList | Array of String | 否 | 010 | 选号的降级城市 |
AxConflictAxbFlag | Integer | 否 | 1 | ax是否与axb冲突(0 不冲突 1 冲突),默认0 |
AudioRecordFlag | Integer | 否 | 1 | 是否需要录音 0:关闭,1 : 开启(默认开启) |
CityCode | String | 否 | 010 | 选号指定城市; 选号优先级: CityCode > CityCodeByPhoneNo(如果传B号码,则按B号码所在城市选号,如果不传B号码,则按A号码所在城市选号)> degradeCityList 降级城市(城市Code详见链接)选号指定城市; |
ExpireTime | Long | 是 | 1608209071 | 过期时间(以秒为单位的时间戳,必须晚于当前时间1分钟以上且早于2038-01-01 00:00:00) |
NumberPoolNo | String | 是 | NP160084061100694433 | X号码所在的号码池编号 |
PhoneNoA | String | 是 | 13700000000 | A号码,可设置为手机号码或固定电话。固定电话需要加区号,区号和号码中间不需要加连字符,例如:02131075869。特服号码如95、1010、400、800类别号码请提前联系火山引擎报备。 |
PhoneNoB | String | 否 | 13700000001 | B号码,可设置为手机号码或固定电话。固定电话需要加区号,区号和号码中间不需要加连字符,例如:02131075869。特服号码如95、1010、400、800类别号码请提前联系火山引擎报备。 |
RandomFlag | Integer | 否 | 1 | 是否使用随机选号 0:关闭(默认关闭),1 : 开启。 |
UserData | String | 否 | 123456 | 用户侧数据,最大长度为2048 |
CallDisplayType | Integer | 否 | 1 | 是否透传 1:不透传,2:A看见B的真实号码,3:B看见A的真实号码,4:看见对方真实号码 |
VerifyFlag | Integer | 否 | 0 | 是否需要语音验证 0:关闭(默认关闭),1 : 开启 |
VoiceCode | String | 否 | abc.mp3 | 放音编码 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
SubId | String | S160817372431596661 | 绑定关系ID |
PhoneNoX | String | 17000000000 | X号码 |
Status | Integer | 1 | 绑定关系状态(0已解绑,1已绑定,2绑定异常) |
PhoneNoXCityCode | String | 010 | X号码城市code |
PhoneNoA | String | 17000000000 | A号码 |
PhoneNoACityCode | String | 010 | A号码城市code |
PhoneNoB | String | 17000000001 | B号码 |
PhoneNoBCityCode | String | 010 | B号码城市code |
POST /?Action=SelectNumberAndBindAXB&Version=2022-01-01 HTTP/1.1 Host: https://cloud-vms.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20250603T112142Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250603/cn-beijing/vms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "AxConflictAxbFlag": "0", "CityCodeByPhoneNo": "A", "OutId": "abcdef", "DegradeCityList": [ "010" ], "AudioRecordFlag": 1, "CityCode": "010", "ExpireTime": 1608209071, "NumberPoolNo": "NP160084061100694433", "PhoneNoA": "13700000000", "PhoneNoB": "13700000001", "RandomFlag": 1, "UserData": "123456", "VerifyFlag": 0 }
{ "ResponseMetadata": { "RequestId": "202503102308362452260641709B5958", "Action": "SelectNumberAndBindAXB", "Version": "2022-01-01", "Service": "vms", "Region": "cn-beijing" }, "Result": { "SubId": "S160817372431596661", "PhoneNoX": "17000000000", "Status": 1, "PhoneNoXCityCode": "010", "PhoneNoA": "YiZXOxjK0", "PhoneNoACityCode": "010" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | MissingParameter | |
400 | InvalidParameter | |
400 | OperationDenied | |
400 | QuotaExceeded | |
400 | IdempotentParameterMismatch | |
400 | DryRunOperation | |
400 | MissingAction | |
400 | InvalidAction | |
500 | InternalError | |
503 | ServiceUnavailable |