You need to enable JavaScript to run this app.
导航
语音服务
  • 文档首页
    • /
  • 语音服务

AX升级AXB关系

最近更新时间：2023.08.17 20:57:03

首次发布时间：2023.02.28 20:31:37

我的收藏

当原有AX关系需要升级AXB时，使用当前接口进行升级绑定。

1. 接口说明

  • 请求方式：POST

  • 接口地址：https://cloud-vms.volcengineapi.com

2. 请求参数
参数数据类型是否必填示例值描述
X-DateString是20201103T104027Z鉴权字段。请参考文档中心-火山引擎。

Authorization

String

是

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎。

ServiceNameString是vms服务名称。语音服务的服务名称是vms。
RegionString是cn-north-1区域名称，固定值cn-north-1。

Content-Type

String

是

application/x-www-form-urlencoded

指定请求消息体的结构化格式。语音服务的 Content-Type 为application/x-www-form-urlencoded。

Query

参数数据类型是否必填示例值描述
ActionString是UpgradeAXToAXB接口名称。该接口固定值为UpgradeAXToAXB。
VersionString是2022-01-01接口版本。语音服务默认接口版本为2022-01-01。

Body

参数数据类型是否必填示例值描述
NumberPoolNoString是NP160084061100694433号码池编号
SubIdString是S160817372431596661绑定关系ID

PhoneNoB

String

是

13700000001

B号码，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869

UserDataString否123用户拓展参数，最大长度为2048
OutIdString否45354657外部业务id，最大长度128位

CallDisplayType

Integer

否

1

是否透传 1：不透传，2：A看见B的真实号码，3：B看见A的真实号码，4：看见对方真实号码

3. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数数据类型描述
RequestIdString请求 ID。
ActionString请求的接口名称。
VersionString请求的版本号。
ServiceString请求的服务名称。
RegionString请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。

Result

参数数据类型示例值描述
SubIdStringS160817372431596662绑定关系ID
PhoneNoXString17000000000X号码
StatusInteger1绑定关系状态（0 已解绑，1 已绑定，2 绑定异常）
PhoneNoXCityCodeString010X号码城市code
PhoneNoAString17000000000A号码
PhoneNoACityCodeString010A号码城市code
PhoneNoBString17000000001B号码
PhoneNoBCityCodeString010B号码城市code

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。
4. 示例

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com/?Action=UpgradeAXToAXB&Version=2022-01-01' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--data-urlencode 'NumberPoolNo=NP167091949502821554' \
--data-urlencode 'PhoneNoB=13710000000' \
--data-urlencode 'SubId=S1672131870644092fd87e' \
--data-urlencode 'UserData=123' \
--data-urlencode 'CallDisplayType=1'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "2022122717062705182BB6BF8F74687A1F",
        "Action": "UpgradeAXToAXB",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "PhoneNoX": "15500000000",
        "PhoneNoXCityCode": "010",
        "SubId": "S16721319876440c205139",
        "Status": 1,
        "PhoneNoA": "15500000001",
        "PhoneNoACityCode": "010",
        "PhoneNoB": "15500000002",
        "PhoneNoBCityCode": "010"
    }
}
  • 错误返回示例
{
    "ResponseMetadata": {
        "RequestId": "20221227170910C9431D87A00C8F6F3CB8",
        "Action": "UpgradeAXToAXB",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "IllegalArgument",
            "Message": "PhoneNoB is required"
        }
    }
}