调用IvrCall向指定号码发起交互式语音通话_语音服务(VS)-阿里云帮助中心

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

接口说明

提交企业资质，并审核通过。具体操作，请参见提交企业资质。
购买语音号码。具体操作，请参见购买号码。
用户接听电话后会听到一段语音，提示用户按键选择。如果开启了消息回执，语音服务会将客户按键信息返回给调用的业务系统。该接口可用于收集客户的订单确认、问卷调查、满意度调查等信息。

QPS 限制

单用户调用频率：100 次/秒。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
CalledShowNumber	string	是	主叫号码。必须是已购买的号码，单次请求仅支持一个主叫号码。一般号码都有并发数，超过并发数会请求失败。您可以登录语音服务控制台，在语音号码>真实号管理页面查看已购买的号码。	0571****5678
CalledNumber	string	是	被叫号码。仅支持中国内地号码，单次请求仅支持一个号码。	1590****000
StartCode	string	是	呼叫开始时播放的提示音。语音文件：语音 ID。您可以登录语音服务控制台，在语音文件管理页面查看语音 ID。文本转语音模板：模板 ID。您可以登录语音服务控制台，在语音消息>语音通知>文本转语音模板页面查看模板 ID。	TTS_1234****
StartTtsParams	string	否	文本转语音模板内的变量参数，格式为 JSON。说明当 StartCode 为文本转语音模板（TTS）且模板中带变量的情况下，此参数必填。	{"name":"xxx","code":"123"}
PlayTimes	long	否	重复播放次数。取值范围为1~3。	3
ByeCode	string	否	播放结束时播放的结束提示音。支持以下两种方式：语音文件：语音 ID。您可以登录语音服务控制台，在语音文件管理页面查看语音 ID。文本转语音模板：模板 ID。您可以登录语音服务控制台，在国内语音单呼>语音通知>文本转语音模板页面查看模板 ID。说明参数 ByeCode 的类型需要与参数 StartCode 一致，即必须同时为语音文件或同时为文本转语音（TTS）模板。	TTS_1234****
ByeTtsParams	string	否	文本转语音模板中的变量参数。格式为 JSON。说明当 ByeCode 为文本转语音（TTS）模板且模板中带变量的情况下，此参数必填。	{"name":"xxx","code":"123"}
Timeout	integer	否	等待用户按键超时时间。单位：毫秒。	3000
OutId	string	否	预留给调用方使用的 ID。最终会通过在回执消息中将此 ID 带回给调用方。字符串类型，长度为 1~15 个字节。	PR0210428****
MenuKeyMap	array<object>	是	按键信息。
	object	是	按键信息。
Key	string	否	被叫方可按的电话按键。	1
TtsParams	string	否	文本转语音模板内的变量参数，格式为 JSON。说明当MenuKeyMap.N.Code是文本转语音模板（TTS）时，对应的模板变量替换关系。当MenuKeyMap.N.Code为文本转语音模板（TTS）且模板中带变量的情况下，此参数为必填。	{"name":"xxx","code":"123"}
Code	string	否	MenuKeyMap.N.Key中指定按键对应的提示音。支持以下两种方式：语音文件：语音 ID。您可以登录语音服务控制台，在语音文件管理页面查看语音 ID。文本转语音模板：模板 ID。您可以登录语音服务控制台，在语音消息>语音通知>文本转语音模板页面查看模板 ID。	TTS_1235****

返回参数

名称	类型	描述	示例值
	object	返回数据。
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见 API 错误码。	OK
Message	string	状态码的描述。	OK
RequestId	string	请求 ID。	D9CB3933-9FE3-4870-BA8E-2BEE91B69D23
CallId	string	此次通话的唯一回执 ID。 CallId 可以通过 QueryCallDetailByCallId 接口查询指定通话的呼叫详情。	116012354148^10281378****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-06-26	API 内部配置变更，不影响调用	查看变更详情