调用Click2Call接口发起一次双向呼叫。接口调用后,语音服务会发起两次呼叫,首先使用主叫外显号码呼叫主叫号码,然后使用被叫外显号码呼叫被叫号码,语音服务会桥接两次呼叫,使主被叫建立通话。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | Click2Call | 要执行的操作,取值:Click2Call。 |
Version | String | 是 | 2022-01-01 | API的版本,取值:2022-01-01。 |
MaxTime | Integer | 否 | 0 | 本次通话进行的最长时长(分钟),从被叫接通时刻开始计算,时长取值范围为01440分钟。0:系统不主动挂断,由主被叫挂断;11440:当通话时长达到该值,系统挂断;默认值0 |
Caller | String | 是 | 13700000000 | 主叫,可设置为手机号码或固定电话。固定电话需要加区号,区号和号码中间不需要加连字符,例如:02131075869 |
CallerNumber | String | 否 | 01080000001 | 主叫侧外显号码,支持指定一个固话号码; |
CallerNumberPoolNo | String | 是 | NP160000111122223333 | 主叫侧外显号码所在的号码池编号; |
CallerNumberCityCode | String | 否 | 010 | 主叫侧外显号码所在归属地城市区号; |
CallerNumberDegradeCityList | Array of String | 是 | 010,021 | 主叫侧外显号码选号降级城市列表,当指定城市(CallerNumberCityCode)选不到号时将会按降级城市进行选号; |
CallerDegradeToCapital | Integer | 否 | 0 | 主叫号码归属地城市选不到号之后是否降级至主叫号码归属地省会城市进行选号,0为否,1为是,主叫外显未指定时有效 |
Callee | String | 是 | 13700000002 | 被叫,可设置为手机号码或固定电话。固定电话需要加区号,区号和号码中间不需要加连字符,例如:02131075869 |
CalleeNumber | String | 否 | 01080000002 | 被叫侧外显号码,支持指定一个固话号码; |
CalleeNumberPoolNo | String | 是 | NP160000111122226666 | 被叫侧外显号码所在的号码池编号; |
CalleeNumberCityCode | String | 否 | 010 | 被叫侧外显号码所在归属地城市区号;城市Code详见链接 |
CalleeNumberDegradeCityList | Array of String | 否 | 010 | 被叫侧外显号码选号降级城市列表,当指定城市(CalleeNumberCityCode)选不到号时将会按降级城市进行选号;最多支持设置5个降级城市;CalleeNumberCityCode非空时有效;城市Code详见链接 |
CalleeDegradeToCapital | Integer | 否 | 0 | 被叫号码归属地城市选不到号之后是否降级至被叫号码归属地省会城市进行选号,0为否,1为是,被叫外显未指定时有效;降级顺序:指定城市(如设置)>被叫归属地>被叫归属地省会城市>指定降级城市,降级时会做针对城市做去重 |
LastMinutes | Integer | 否 | 60 | 最后时间提示触发时间(分钟),倒数x分钟时播放 |
PreVoice | String | 否 | xx.mp3 | 主叫提示音,放音内容默认为“正在呼叫中,请稍后” |
LastVoice | String | 否 | xxx.wav | 最后提示音,默认“本次通话将在x分钟后结束” |
LastVoiceTo | String | 否 | CALLER | 最后提示音放音方,主叫CALLER,被叫CALLEE,双方BOTH,默认不播放 |
UserData | String | 否 | abcdef | 用户数据 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
CallId | String | Dcc0143d97c773af84077addfdd84f9d861f6 | 通话id |
POST /?Action=Click2Call&Version=2022-01-01 HTTP/1.1 Host: https://cloud-vms.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20250603T074947Z 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 { "Caller": "13700000000", "CallerNumber": "01080000001\n\n", "CallerNumberPoolNo": "NP160000111122223333", "CallerNumberCityCode": "010", "CallerNumberDegradeCityList": [ "010,021" ], "CallerDegradeToCapital": 0, "Callee": "13700000002", "CalleeNumber": "01080000002", "CalleeNumberPoolNo": "NP160000111122226666", "CalleeNumberCityCode": "010", "CalleeNumberDegradeCityList": "010,021", "CalleeDegradeToCapital": 0, "Maxtime": 10, "LastMinutes": 60, "PreVoice": "xx.mp3", "LastVoice": "xxx.wav", "LastVoiceTo": "CALLER", "UserData": "abcdef" }
{ "ResponseMetadata": { "RequestId": "20250315210453114153022174C82A42", "Action": "Click2Call", "Version": "2022-01-01", "Service": "vms", "Region": "cn-beijing" }, "Result": { "CallId": "Dcc0143d97c773af84077addfdd84f9d861f6" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
200 | SystemError | |
200 | IllegalArgument | |
200 | AccountSubServiceException | |
200 | NumberNotEnough |