调用ClickToDial接口发起一次双方通话。接口调用成功后,语音服务使用主叫显号打给主叫号码,然后使用被叫显号打给被叫号码,为主叫和被叫号码双方发起一次语音通信。语音通信过程中,通话双方显示的号码均为语音服务平台号码。

使用说明

ClickToDial接口暂不支持公共号池号码。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ClickToDial

系统规定参数。取值:ClickToDial

CallerShowNumber String 05715678****

主叫显号。

必须是已购买的号码。您可以登录语音服务控制台,选择号码申请>语音号码查看已购买的号码。

CallerNumber String 1590000****

主叫号码。仅支持中国内地号码。

CalledShowNumber String 05715566****

被叫显号。

必须是已购买的号码。您可以登录语音服务控制台,选择号码申请>语音号码查看已购买的号码。

CalledNumber String 1580000****

被叫号码。仅支持中国内地号码。

RecordFlag Boolean true

通话过程是否录音。取值:

  • true:录音。
  • false:不录音。
AsrFlag Boolean true

是否开启实时ASR功能。

  • true:开启。
  • false:不开启。
SessionTimeout Integer 100

整个通话的最长时长。单位:秒。

超过该时长后系统自动挂断电话。

AsrModelId String 2070aca1eff146f9a7bc826f1c3d4****

ASR模型ID。

您可以登录语音服务控制台,在ASR语言模型管理中查看ASR模型ID。

OutId String abcdefgh

预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。

字符串类型,长度为1~15个字节。

返回数据

名称 类型 示例值 描述
Code String OK

请求状态码。

  • 返回OK代表请求成功。
  • 其他错误码详见API错误码
Message String OK

状态码的描述。

RequestId String D9CB3933-9FE3-4870-BA8E-2BEE91B69D23

请求ID。

CallId String 116012354148^1028137841****

此次通话的唯一回执ID。CallId可以通过QueryCallDetailByCallId接口查询呼叫详情。

示例

请求示例

http(s)://dyvmsapi.aliyuncs.com/?Action=ClickToDial
&CallerShowNumber=05715678****
&CallerNumber=1590000****
&CalledShowNumber=05715566****
&CalledNumber=1580000****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ClickToDialResponse>
    <Code>OK</Code>
    <Message>OK</Message>
    <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>
    <CallId>116012354148^1028137841****</CallId>
</ClickToDialResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : "OK",
  "Message" : "OK",
  "RequestId" : "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
  "CallId" : "116012354148^1028137841****"
}

错误码

访问错误中心查看更多错误码。