文档中心

发起双呼

最近更新时间：2023.08.17 21:00:29

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

调用Click2Call接口发起一次双向呼叫。接口调用后，语音服务会发起两次呼叫，首先使用主叫外显号码呼叫主叫号码，然后使用被叫外显号码呼叫被叫号码，语音服务会桥接两次呼叫，使主被叫建立通话。

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

Body

参数	数据类型	是否必选	示例值	描述
Caller	String	是	13700000000	主叫，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869
CallerNumber	String	否	01080000001	主叫侧外显号码，支持指定一个固话号码；非空时忽略CallerNumberCityCode与CallerNumberDegradeCityList参数，直接使用指定号码，请确保此时号码的可用性；需要加区号，区号和号码中间不需要加连字符，例如：02131075869
CallerNumberPoolNo	String	是	NP160000111122223333	主叫侧外显号码所在的号码池编号；请确保号码池中有可用号码
CallerNumberCityCode	String	否	010	主叫侧外显号码所在归属地城市区号；城市Code详见链接
CallerNumberDegradeCityList	String	否	010,021	主叫侧外显号码选号降级城市列表，当指定城市（CallerNumberCityCode）选不到号时将会按降级城市进行选号；最多支持设置5个降级城市； CallerNumberCityCode非空时有效；城市Code详见链接
CallerDegradeToCapital	Integer	否	0	主叫号码归属地城市选不到号之后是否降级至主叫号码归属地省会城市进行选号，0为否，1为是，主叫外显未指定时有效降级顺序：指定城市（如设置） > 主叫归属地 > 主叫归属地省会城市 > 指定降级城市，降级时会做针对城市做去重
Callee	String	是	13700000002	被叫，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869
CalleeNumber	String	否	01080000002	被叫侧外显号码，支持指定一个固话号码；非空时忽略CallerNumberCityCode与CallerNumberDegradeCityList参数，直接使用指定号码，请确保此时号码的可用性；需要加区号，区号和号码中间不需要加连字符，例如：02131075869
CalleeNumberPoolNo	String	是	NP160000111122226666	被叫侧外显号码所在的号码池编号；请确保号码池中有可用号码
CalleeNumberCityCode	String	否	010	被叫侧外显号码所在归属地城市区号；城市Code详见链接
CalleeNumberDegradeCityList	String	否	010,021	被叫侧外显号码选号降级城市列表，当指定城市（CalleeNumberCityCode）选不到号时将会按降级城市进行选号；最多支持设置5个降级城市； CalleeNumberCityCode非空时有效；城市Code详见链接
CalleeDegradeToCapital	Integer	否	0	被叫号码归属地城市选不到号之后是否降级至被叫号码归属地省会城市进行选号，0为否，1为是，被叫外显未指定时有效降级顺序：指定城市（如设置） > 被叫归属地 > 被叫归属地省会城市 > 指定降级城市，降级时会做针对城市做去重
Maxtime	Integer	否	10	本次通话进行的最长时长（分钟），从被叫接通时刻开始计算，时长取值范围为0~1440分钟。 0：系统不主动挂断，由主被叫挂断 1~1440：当通话时长达到该值，系统挂断默认值0
LastMinutes	Integer	否	60	最后时间提示触发时间（分钟），倒数x分钟时播放
PreVoice	String	否		主叫提示音，放音内容默认为“正在呼叫中，请稍后”
LastVoice	String	否		最后提示音，默认“本次通话将在x分钟后结束”
LastVoiceTo	String	否	CALLER	最后提示音放音方，主叫CALLER，被叫CALLEE，双方BOTH，默认不播放
UserData	String	否		用户数据

3. 返回参数

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

ResponseMetadata

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

Result

参数	数据类型	示例值	描述
CallId	String	Dcc0143d97c773af84077addfdd84f9d861f6	通话id

Error

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

4. 示例

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com?Action=Click2Call&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 'Caller=13700000000' \
--data-urlencode 'CallerNumberPoolNo=NP160102xxxx' \
--data-urlencode 'Callee=13700000001' \
--data-urlencode 'CalleeNumberPoolNo=NP160102206xxxx' \
--data-urlencode 'UserData=1234'

返回示例

正确返回示例

{
    "ResponseMetadata": {
        "RequestId": "20201217105523010225107093230085E8",
        "Action": "Click2Call",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "CallId": "Dcc0143d97c773af84077addfdd84f9d861f6"
    }
}

错误返回示例

{
    "ResponseMetadata": {
        "RequestId": "202212261935046E15B193C341395956D4",
        "Action": "Click2Call",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "NumberNotEnough",
            "Message": "caller[NP160xxx] number not enough"
        }
    }
}

1. 接口说明

2. 请求参数

Header

Query

Body

3. 返回参数

ResponseMetadata

Result

Error

4. 示例

请求示例

返回示例