文档中心

AXNE绑定

最近更新时间：2024.02.02 15:56:32

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

通过该接口进行AXNE关系绑定。

1. 接口说明

请求方式：POST
接口地址：https://cloud-vms.volcengineapi.com

AXNE模式目前支持自动绑定AXB，即B通过号码X和分机号E，给A拨号后，支持自动绑定AXB，这里的X与AXNE中的X不是一个号码，暂时称其为Y。此时A拨打Y号码即可完成回拨，反向接通B。下文中AutoCreateFlag设置为1，即可自动完成AXB的绑定，后续几个Axb开头的参数都是对这次AXB绑定的配置。如果AutoCreateFlag设置为0，则不进行自动绑定，用户可以手动触发，参考AXNE中AXB绑定

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

Body

参数	数据类型	是否必填	示例值	描述
PhoneNoA	String	是	13700000000	A号码，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869。特服号码如95、1010、400、800类别号码请提前联系火山引擎报备。
PhoneNoB	String	否	13700000001	B号码，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869。特服号码如95、1010、400、800类别号码请提前联系火山引擎报备。
PhoneNoX	String	否	13700000002	X号码
PhoneNoE	String	否	9999	E号码（分机号）
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	否	12345	用户拓展参数，最大长度为2048
AutoCreateFlag	Integer	否	1	是否自动创建AXB关系 0：关闭（默认关闭），1 : 开启
AxbNumberPoolNo	String	否	NP160084061100694434	AXB关系X号码所在的号码池编号
AxbEnableDuration	Integer	否	180	AXB关系有效时长（单位秒）
AxbAudioRecordFlag	Integer	否	1	AXB关系是否需要录音 0：关闭，1 : 开启（默认开启）
AxbCityCode	String	否	010	AXB选X号码指定城市；选X号码优先级： XCityCode > XCityCodeByPhoneNo（如果传B号码，则按B号码所在城市选号，如果不传B号码，则按A号码所在城市选号）> XDegradeCityList 降级城市（城市Code详见https://www.volcengine.com/docs/6358/67668）选号指定城市；
AxbCityCodeByPhoneNo	String	否	A	AXB中根据哪个号码所在的城市选X号码（A：A号码所在城市，B：B号码所在城市）（默认A）
AxbDegradeCityList	List	否	010,0531	AXB中X号码降级城市列表，当指定城市选不到号时将会按降级城市进行选号；若希望按照省会城市降级，需要在降级列表中加入"PNPC"代表省会城市降级。例: ("PNPC","010","021")。最多支持设置5个降级城市；城市Code详见链接
RandomFlag	Integer	否	1	是否使用随机选号 0：关闭（默认关闭），1 : 开启。

注：PhoneNoX不传或为空时，系统会根据CityCode，CityCodByPhoneNo，DegradeCityList等参数进行选号
注：若AutoCreateFlag为1，则AxbNumberPoolNo和AxbEnableDuration为必传字段

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号码
PhoneNoE	String	9999	E号码（分机号）
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=BindAXNE&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=NP16709193440200000' \
--data-urlencode 'PhoneNoA=13900000000' \
--data-urlencode 'PhoneNoB=13900000001' \
--data-urlencode 'ExpireTime=1672406820' \
--data-urlencode 'audioRecordFlag=1' \
--data-urlencode 'userData=test user data' \
--data-urlencode 'CityCode=010' \
--data-urlencode 'AutoCreateFlag=1' \
--data-urlencode 'AxbNumberPoolNo=NP167091951102820000' \
--data-urlencode 'AxbEnableDuration=12000' \
--data-urlencode 'AxbDegradeCityList=010'

返回示例

正确返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022122814310869EC9F68E8FBCA80A890",
        "Action": "BindAXNE",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "PhoneNoX": "13240420000",
        "PhoneNoE": "9999",
        "SubId": "S16722090689534a63c75c",
        "Status": 1,
        "PhoneNoXCityCode": "010",
        "PhoneNoA": "13900000000",
        "PhoneNoACityCode": "0431",
        "PhoneNoB": "13900000001",
        "PhoneNoBCityCode": "010"
    }
}

错误返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221228143438DC13A8C6DB847984939C",
        "Action": "BindAXNE",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "IllegalArgument",
            "Message": "AxbNumberPoolNo is required"
        }
    }
}

1. 接口说明

2. 请求参数

Header

Query

Body

3. 返回参数

ResponseMetadata

Result

Error

4. 示例

请求示例

返回示例

语音服务

AXNE绑定

Header

Query

Body

ResponseMetadata

Result

Error

请求示例

返回示例