调用ClickToDial发起一次双方通话。

接口说明

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

调用该接口前,请您注意:
  • 已实名认证为企业用户,并审核通过了企业资质。
  • 已在语音服务控制台上购买了号码。
  • 请确保在使用该接口前,已充分了解语音服务产品的收费方式和价格

调试

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

请求参数

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

系统规定参数。取值:ClickToDial

CalledNumber String 1370000xxxx

被叫号码。仅支持中国大陆号码。

CalledShowNumber String 0571xxxx

被叫显号,必须是已购买的号码。

您可以在语音服务控制台上查看已购买的号码。

CallerNumber String 1370000xxxx

主叫号码。仅支持中国大陆号码。

CallerShowNumber String 0571xxxx

主叫显号,必须是已购买的号码。

您可以在语音服务控制台上查看已购买的号码。

RecordFlag Boolean true

通话过程是否录音,取值:true|false。

AsrFlag Boolean true

是否开启实时ASR功能,取值:true|false。

SessionTimeout Integer 100

整个通话的最长时长,单位为秒。超过该时长后系统自动挂断电话。

AsrModelId String 2070aca1eff146f9a7bc826f1c3d4d33

ASR模型ID。请在ASR模型管理页面查看ASR模型ID。

OutId String abcdefgh

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

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

返回数据

名称 类型 示例值 描述
CallId String 116012354148^1028137841xxxx

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

Code String OK

请求状态码。

Message String OK

状态码的描述。

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

请求ID。

示例

请求示例

http(s)://dyvmsapi.aliyuncs.com/?Action=ClickToDial
&CalledShowNumber=0571xxxx
&CallerNumber=1370000xxxx
&CallerShowNumber=0571xxxx
&CalledNumber=1370000xxxx
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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