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

文档中心

立即注册

导航

AXYB绑定

最近更新时间：2023.11.08 18:12:40首次发布时间：2023.02.28 20:31:38

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

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	是	BindAXYB	接口名称。该接口固定值为`BindAXYB`。
Version	String	是	2022-01-01	接口版本。语音服务默认接口版本为`2022-01-01`。

Body

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

注：PhoneNoX不传或为空时，我们会根据CityCode，CityCodByPhoneNo，DegradeCityList等参数进行选号。
注：传B号码，同时建立AX和YB两个关系；若不传B号码，则仅建立AX关系。

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	S160817372431596661	绑定关系ID
PhoneNoX	String	17000000000	X号码
Status	Integer	1	绑定关系状态（0 已解绑，1 已绑定，2 绑定异常）
YbSubId	String	S16081737243159666100001111	YB绑定关系ID
PhoneNoY	String	17000000001	Y号码
YbStatus	Integer	1	YB绑定关系状态（0 已解绑，1 已绑定，2 绑定异常）

Error

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

4. 示例

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com/?Action=BindAXYB&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=NP166265127200000' \
--data-urlencode 'PhoneNoA=13700000000' \
--data-urlencode 'PhoneNoB=13700000001' \
--data-urlencode 'ExpireTime=1672406820' \
--data-urlencode 'audioRecordFlag=1' \
--data-urlencode 'userData=test user data' \
--data-urlencode 'CityCode=010' \
--data-urlencode 'YbEnableDuration=600' \
--data-urlencode 'NumberPoolNoY=NP16626512720200000'

返回示例

正确返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221228153118C335D64449FE1E248347",
        "Action": "BindAXYB",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "PhoneNoX": "131600000",
        "SubId": "S1672212679000000",
        "Status": 1,
        "PhoneNoY": "1767000000",
        "YbSubId": "S16722126795817211a000000",
        "YbStatus": 1
    }
}

错误返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221228153018726F8DC758E0D68251AC",
        "Action": "BindAXYB",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "NumberNotEnough",
            "Message": "Number not enough"
        }
    }
}

语音服务