BindAXYB - 绑定AXYB--语音服务-火山引擎

文档中心

立即注册

导航

BindAXYB - 绑定AXYB

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

通过该接口创建AXYB绑定关系

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	BindAXYB	要执行的操作，取值：BindAXYB。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
ExpireTime	Long	是	1608209071	过期时间（以秒为单位的时间戳，必须晚于当前时间1分钟以上且早于2038-01-01 00:00:00）
PhoneNoA	String	是	13700000000	A号码，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869。特服号码如95、1010、400、800类别号码请提前联系火山引擎报备。
NumberPoolNo	String	是	NP160084061100694433	X号码所在的号码池编号
CityCode	String	否	010	选号指定城市；选号优先级： CityCode >CityCodeByPhoneNo（如果传B号码，则按B号码所在城市选号，如果不传B号码，则按A号码所在城市选号）> degradeCityList 降级城市（城市Code详见链接）选号指定城市；
DegradeCityList	Array of String	否	010,0531	降级城市列表，当指定城市选不到号时将会按降级城市进行选号；若希望按照省会城市降级，需要在降级列表中加入"PNPC"代表省会城市降级。例: ("PNPC","010","021")。最多支持设置5个降级城市；
PhoneNoX	String	否	13700000002	X号码
PhoneNoY	String	否	13700000001	Y号码
RandomFlagY	Integer	否	0	是否对Y号码使用随机选号 0：关闭（默认关闭），1 : 开启。
RandomFlag	Integer	否	1	是否使用随机选号 0：关闭（默认关闭），1 : 开启。
YCityCodeByPhoneNo	String	否	A	根据哪个号码所在的城市选Y号码（A：A号码所在城市，B：B号码所在城市）（默认A）
YDegradeCityList	Array of String	否	010,0531	Y号码降级城市列表，当指定城市选不到号时将会按降级城市进行选号；若希望按照省会城市降级，需要在降级列表中加入"PNPC"代表省会城市降级。例: ("PNPC","010","021")。最多支持设置5个降级城市；城市Code详见链接
YCityCode	String	否	021	选Y号码指定城市；选Y号码优先级： YCityCode > YCityCodeByPhoneNo（如果传B号码，则按B号码所在城市选号，如果不传B号码，则按A号码所在城市选号）> YDegradeCityList 降级城市（城市Code详见链接）选号指定城市；
YbAudioRecordFlag	Integer	否	1	YB关系是否需要录音 0：关闭，1 : 开启（默认开启）
YbEnableDuration	Integer	是	180	YB关系有效时长（单位秒）
NumberPoolNoY	String	是	NP160084061100694434	Y号码所在的号码池编号
PhoneNoB	String	否	13700000001	B号码，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869。特服号码如95、1010、400、800类别号码请提前联系火山引擎报备。
AutoCreateFlag	Integer	否	0	是否自动创建YB关系 0：关闭，1 : 开启（默认开启）
AudioRecordFlag	Integer	否	1	是否需要录音 0：关闭，1 : 开启（默认开启）
CityCodeByPhoneNo	String	否	A	根据哪个号码所在的城市选号（A：A号码所在城市，B：B号码所在城市）（默认A）
UserData	String	否	123456	用户拓展参数，最大长度为2048

返回参数

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

参数	类型	示例值	描述
SubId	String	S160817372431596661	绑定关系ID
PhoneNoX	String	13700000001	X号码
Status	Integer	1	绑定关系状态（0 已解绑，1 已绑定，2 绑定异常）
YbSubId	String	S16081737243159666100001111	YB绑定关系ID
PhoneNoY	String	17000000001	Y号码
YbStatus	Integer	1	YB绑定关系状态（0 已解绑，1 已绑定，2 绑定异常）

请求示例

POST /?Action=BindAXYB&Version=2022-01-01 HTTP/1.1
Host: https://cloud-vms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250603T104920Z
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",
  "ExpireTime": 1608209071,
  "PhoneNoA": "13700000000",
  "PhoneNoX": "13700000002",
  "CityCode": "010",
  "CityCodeByPhoneNo": "A",
  "DegradeCityList": [
    "010","0531"
  ],
  "AudioRecordFlag": 1,
  "AutoCreateFlag": 0,
  "PhoneNoY": "13700000001",
  "YbEnableDuration": 180,
  "NumberPoolNoY": "NP160084061100694434",
  "YbAudioRecordFlag": 1,
  "PhoneNoB": "13700000001",
  "RandomFlag": 1,
  "YCityCode": "TpnSqYQl",
  "YCityCodeByPhoneNo": "A",
  "YDegradeCityList": [
    "010,0531"
  ],
  "RandomFlagY": 0,
  "UserData": "123456"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250313140149156113055039E66F93",
    "Action": "BindAXYB",
    "Version": "2022-01-01",
    "Service": "vms",
    "Region": "cn-beijing"
  },
  "Result": {
    "SubId": "S160817372431596661",
    "PhoneNoX": "myLI320Qxh6",
    "Status": 1,
    "YbSubId": "S16081737243159666100001111",
    "PhoneNoY": "17000000001",
    "YbStatus": 1
  }
}

错误码

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

状态码	错误码	错误信息
200	SystemError	系统错误
200	IllegalPhoneNoX	无效的X号码
200	IllegalArgument	非法的参数
200	IllegalPhoneNoY	无效的Y号码
200	XCanNotEqualsY	X不能和Y相同
200	PhoneNoYAConflicted	YA号码冲突
200	PhoneNoXBConflicted	XB号码冲突