通过该接口进行AXG关系绑定
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | BindAXG | 要执行的操作,取值:BindAXG。 |
Version | String | 是 | 2022-01-01 | API的版本,取值:2022-01-01。 |
ExpireTime | Long | 是 | 1608209071 | 过期时间(以秒为单位的时间戳,必须晚于当前时间1分钟以上且早于2038-01-01 00:00:00) |
NumberPoolNo | String | 是 | NP160084061100694433 | X号码所在的号码池编号 |
PhoneNoX | String | 否 | 13700000002 | X号码 |
AudioRecordFlag | Integer | 否 | 1 | 是否需要录音 0:关闭,1 : 开启(默认开启) |
CityCode | String | 否 | 010 | 选号指定城市; |
CityCodeByPhoneNo | String | 否 | A | 根据哪个号码所在的城市选号(A:A号码所在城市,B:B号码所在城市)(默认A) |
DegradeCityList | Array of String | 否 | 010,0531 | 降级城市列表,当指定城市选不到号时将会按降级城市进行选号;若希望按照省会城市降级,需要在降级列表中加入"PNPC"代表省会城市降级。例: ("PNPC","010","021")。 |
OrderId | String | 否 | skdhwmche | 订单id, 700号码场景必填 |
GroupId | String | 否 | G124213213 | G号码组ID,可以提前通过createAXG接口创建G号码组, 也可以在绑定接口中直接创建G号码组 |
GroupNumbers | Array of String | 否 | 13800000000 | G组号码列表,G号码组中最多添加 200 个号码。(当GroupId为空时,该字段必填) |
GroupName | String | 否 | 测试G组 | G号码组名称。(当GroupId为空时,该字段必填) |
PhoneNoA | String | 是 | 02131075869 | A号码,可设置为手机号码或固定电话。固定电话需要加区号,区号和号码中间不需要加连字符,例如:02131075869。特服号码如95、1010、400、800类别号码请提前联系火山引擎报备。 |
PhoneNoB | String | 否 | 13700000001 | B号码,可设置为手机号码或固定电话。固定电话需要加区号,区号和号码中间不需要加连字符,例如:02131075869。特服号码如95、1010、400、800类别号码请提前联系火山引擎报备。 |
UserData | String | 否 | 123456 | 用户拓展参数,最大长度为2048 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
GroupId | String | G12321 | G组ID |
SubId | String | S160817372431596661 | 绑定关系ID |
PhoneNoX | String | 17000000000 | X号码 |
Status | Integer | 1 | 绑定关系状态(0 已解绑,1 已绑定,2 绑定异常) |
PhoneNoXCityCode | String | 010 | X号码城市code |
POST /?Action=BindAXG&Version=2022-01-01 HTTP/1.1 Host: https://cloud-vms.volcengineapi.com?Action=BindAXG&Version=2022-01-01 Content-Type: application/json; charset=UTF-8 X-Date: 20251103T072507Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251103/cn-beijing/vms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "ExpireTime": 1608209071, "NumberPoolNo": "NP1600xxx061100694433", "PhoneNoA": "02131075869" }
{ "ResponseMetadata": { "RequestId": "20251103152556248011180219E995FF", "Action": "BindAXG", "Version": "2022-01-01", "Service": "vms", "Region": "cn-beijing" }, "Result": { "GroupId": "G72131231", "SubId": "S160817372431596661", "PhoneNoX": "17000000000", "Status": 1, "PhoneNoXCityCode": "010" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
200 | SystemError | |
200 | OverQpsLimit | |
200 | IllegalArgument | |
200 | PhoneNoXOccupied | |
200 | PhoneNoARiskFrozen | |
200 | ConflictWithExisting | |
200 | IllegalPhoneNoX | |
400 | InvalidParameter | |
403 | AccessDenied |