调用IvrCall向指定号码发起交互式语音通话。

接口说明

IvrCall接口用于向指定号码发起交互式语音通话。用户接听到电话后,播放一段语音,提示用户按键进行选择,如果开启了消息回执,语音平台会返回客户按键信息给调用的业务系统。该接口可用于收集客户的订单确认、问卷调查、满意度调查等信息。

调试

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

请求参数

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

系统规定参数。取值:IvrCall

CalledNumber String 1590****000

被叫号码。

仅支持中国内地号码,单次请求仅支持一个号码。

CalledShowNumber String 0571****5678

主叫号码。

必须是已购买的号码,单次请求仅支持一个主叫号码。您可以登录语音服务控制台,选择号码申请>语音号码查看已购买的号码。

StartCode String TTS_1234****

呼叫开始时播放的提示音。

  • 语音文件:语音ID。您可以登录语音服务控制台,选择国内语音单呼叫>语音通知,在语音通知文件页签下查看语音ID。
  • 文本转语音模板:模板ID。您可以登录语音服务控制台,选择国内语音单呼叫>语音通知,在文本转语音模板页签下查看模板ID。
StartTtsParams String {“name”:”xxx”,”code”:”123”}

文本转语音模板内的变量参数,格式为JSON。

StartCode为文本转语音模板(TTS)且模板中带变量的情况下此参数必填。

MenuKeyMap.N.Key String 1

被叫方可按的电话按键。

MenuKeyMap.N.Code String TTS_1234

MenuKeyMap.N.Key中指定按键对应的提示音。支持以下两种方式:

  • 语音文件:语音ID。您可以登录语音服务控制台,选择国内语音单呼叫>语音通知,在语音通知文件页签下查看语音ID。
  • 文本转语音模板:模板ID。您可以登录语音服务控制台,选择国内语音单呼叫>语音通知,在文本转语音模板页签下查看模板ID。
MenuKeyMap.N.TtsParams String {“name”:”xxx”,”code”:”123”}

文本转语音模板内的变量参数,格式为JSON。

  • MenuKeyMap.N.Code是文本转语音模板(TTS)时,对应的模板变量替换关系。
  • MenuKeyMap.N.Code为文本转语音模板(TTS)且模板中带变量的情况下此参数为必填。
PlayTimes Long 3

重复播放次数。取值范围为1~3。

ByeCode String TTS_1234****

播放结束时播放的结束提示音。支持以下两种方式:

  • 语音文件:语音ID。您可以登录语音服务控制台,选择国内语音单呼叫>语音通知,在语音通知文件页签下查看语音ID。
  • 文本转语音模板:模板ID。您可以登录语音服务控制台,选择国内语音单呼叫>语音通知,在文本转语音模板页签下查看模板ID。
说明 参数ByeCode的类型需要与参数StartCode一致,即必须同时为语音文件或文本转语音(TTS)模板。
ByeTtsParams String {“name”:”xxx”,”code”:”123”}

文本转语音模板模板中的变量参数。格式为JSON。

ByeCode为文本转语音(TTS)模板、且模板中带变量的情况下此参数必填。

Timeout Integer 3000

等待用户按键超时时间。单位:毫秒。

OutId String abcd****

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

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

返回数据

名称 类型 示例值 描述
CallId String 116012354148^10281378****

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

Code String OK

请求状态码。

Message String OK

状态码的描述。

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

请求ID。

示例

请求示例

http(s)://dyvmsapi.aliyuncs.com?Action=IvrCall
&CalledNumber=1590****000
&CalledShowNumber=0571****5678
&StartCode=TTS_1234****
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

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