AX升级AXB关系--语音服务-火山引擎

文档中心

立即注册

导航

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-Date	String	是	20201103T104027Z	鉴权字段。请参考文档中心-火山引擎。
Authorization	String	是	HMAC-SHA256 Credential***	鉴权字段。请参考文档中心-火山引擎。
ServiceName	String	是	vms	服务名称。语音服务的服务名称是`vms`。
Region	String	是	cn-north-1	区域名称，固定值`cn-north-1`。
Content-Type	String	是	application/x-www-form-urlencoded	指定请求消息体的结构化格式。语音服务的 Content-Type 为`application/x-www-form-urlencoded`。

Query

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

Body

参数	数据类型	是否必填	示例值	描述
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：看见对方真实号码

3. 返回参数

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	响应公共参数。包含的参数说明请参见 ResponseMetadata。
Result	Result	响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数	数据类型	描述
RequestId	String	请求 ID。
Action	String	请求的接口名称。
Version	String	请求的版本号。
Service	String	请求的服务名称。
Region	String	请求的区域。
Error	Error	错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。

Result

参数	数据类型	示例值	描述
SubId	String	S160817372431596662	绑定关系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

Error

参数	数据类型	描述
Code	String	错误码。
Message	String	错误信息。

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"
        }
    }
}

语音服务

Header

Query

Body

ResponseMetadata

Result

Error

请求示例

返回示例