调用接口IvrCall发起交互式语音通话。

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

调用该接口前,请确认:

说明 请确保在使用该接口前,已充分了解语音服务产品的收费方式和价格

调试

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

请求参数

名称 类型 是否必选 示例值 描述
CalledNumber String 13700000000

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

CalledShowNumber String 4001112222

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

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

StartCode String TTS_1234

呼叫开始时播放的提示音,可以指定为:

AccessKeyId String LTAIP00vvvvvvvvv

主账号AccessKey的ID。

Action String IvrCall

系统规定参数。取值:IvrCall

ByeCode String TTS_1234

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

  • 语音文件
  • 文本转语音(TTS)模板
说明 参数ByeCode的类型需要与参数StartCode一致,即必须同时为语音文件或文本转语音(TTS)模板。
ByeTtsParams String {“name”:”xxx”,”code”:”123”}

文本转语音模板变量替换关系,格式为JSON。

说明ByeCode为文本转语音(TTS)模板、且模板中带变量的情况下此参数为必选。
MenuKeyMap.N.Code String TTS_1234

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

  • 语音文件
  • 文本转语音(TTS)模板
MenuKeyMap.N.Key String 1

被叫方可按的电话按键。

MenuKeyMap.N.TtsParams String {“name”:”xxx”,”code”:”123”}

MenuKeyMap.N.Code是文本转语音模板(TTS)时,对应的模板变量替换关系,格式为JSON。

说明MenuKeyMap.N.Code为文本转语音模板(TTS)、且模板中带变量的情况下此参数为必选。
OutId String abcdefgh

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

PlayTimes Long 3

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

StartTtsParams String {“name”:”xxx”,”code”:”123”}

文本转语音模板(TTS)变量替换关系,格式为JSON。

说明StartCode为文本转语音模板(TTS)、且模板中带变量的情况下此参数为必选。
Timeout Integer 3000

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

返回数据

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

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

Code String OK

请求状态码。

Message String OK

状态码的描述。

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

请求ID。

示例

请求示例


http(s)://[Endpoint]/?CalledNumber=13700000000
&CalledShowNumber=4001112222
&StartCode=TTS_1234
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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