当原有AX关系需要升级AXB时,使用当前接口进行升级绑定
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpgradeAXToAXB | 要执行的操作,取值:UpgradeAXToAXB。 |
Version | String | 是 | 2022-01-01 | API的版本,取值:2022-01-01。 |
NumberPoolNo | String | 是 | NP160084061100694433 | 号码池编号 |
SubId | String | 是 | S160817372431596661 | 绑定关系 ID |
PhoneNoB | String | 是 | 13700000001 | B 号码,可设置为手机号码或固定电话。固定电话需要加区号,区号和号码中间不需要加连字符,例如:02131075869 |
UserData | String | 否 | 123 | 用户拓展参数,最大长度为 2048 |
OutId | String | 否 | 45354657 | 外部业务 id,最大长度 128 位 |
CallDisplayType | Integer | 否 | 1 | 是否透传 1:不透传,2:A看见B的真实号码,3:B看见A的真实号码,4:看见对方真实号码 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SubId | String | S160817372431596662 | 绑定关系id |
PhoneNoX | String | 17000000000 | X 号码 |
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=UpgradeAXToAXB&Version=2022-01-01 HTTP/1.1 Host: https://cloud-vms.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20250603T112328Z 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 { "NumberPoolNo": "NP160084061100694433", "SubId": "S160817372431596661", "PhoneNoB": "13700000001", "UserData": "123", "OutId": "45354657", "CallDisplayType": 1 }
{ "ResponseMetadata": { "RequestId": "2025031721412915421515007346B1E5", "Action": "UpgradeAXToAXB", "Version": "2022-01-01", "Service": "vms", "Region": "cn-beijing" }, "Result": { "SubId": "S160817372431596662", "PhoneNoX": "17000000000", "PhoneNoXCityCode": "010", "PhoneNoA": "17000000000", "PhoneNoACityCode": "010", "PhoneNoB": "17000000001", "PhoneNoBCityCode": "010" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
200 | SystemError | |
200 | UnauthenticatedRequest | |
200 | IllegalArgument | |
200 | IllegalPhoneNoX | |
200 | ConflictWithExisting |