BindAXN - 绑定AXN--语音服务-火山引擎

文档中心

立即注册

导航

BindAXN - 绑定AXN

最近更新时间：2025.07.11 17:27:24首次发布时间：2025.07.11 17:27:24

通过该接口进行AXN关系绑定(指定X号码)

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	BindAXN	要执行的操作，取值：BindAXN。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
PhoneNoA	String	是	13700000000	A号码，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869。特服号码如95、1010、400、800类别号码请提前联系火山引擎报备。
PhoneNoB	String	否	13700000001	B号码，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869。特服号码如95、1010、400、800类别号码请提前联系火山引擎报备。
NumberPoolNo	String	是	NP160084061100694433	X号码所在的号码池编号
PhoneNoX	String	是	13700000002	X号码
ExpireTime	Long	是	1608209071	过期时间（以秒为单位的时间戳，必须晚于当前时间1分钟以上且早于2038-01-01 00:00:00）
AudioRecordFlag	Integer	否	1	是否需要录音 0：关闭，1 : 开启（默认开启）
UserData	String	否	123456	用户拓展参数，最大长度为2048

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
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=BindAXN&Version=2022-01-01 HTTP/1.1
Host: https://cloud-vms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250603T095546Z
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

{
  "PhoneNoA": "13700000000",
  "PhoneNoB": "13700000001",
  "NumberPoolNo": "NP160084061100694433",
  "PhoneNoX": "13700000002",
  "ExpireTime": 1608209071,
  "AudioRecordFlag": 1,
  "UserData": "123456"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250310224421047255158250B3B1F8",
    "Action": "BindAXN",
    "Version": "2022-01-01",
    "Service": "vms",
    "Region": "cn-beijing"
  },
  "Result": {
    "SubId": "S160817372431596661",
    "PhoneNoX": "17000000000",
    "Status": 1,
    "PhoneNoXCityCode": "010",
    "PhoneNoA": "17000000000",
    "PhoneNoACityCode": "010",
    "PhoneNoB": "17000000001",
    "PhoneNoBCityCode": "010"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
200	SystemError	系统错误
200	IllegalPhoneNoX	无效的X号码
200	ConflictWithExisting	与现有绑定关系冲突
200	IllegalArgument	非法的参数