向指定号码发起交互式语音通话。
接口说明
提交企业资质,并审核通过。具体操作,请参见提交企业资质。
购买语音号码。具体操作,请参见购买号码。
用户接听电话后会听到一段语音,提示用户按键选择。如果开启了消息回执,语音服务会将客户按键信息返回给调用的业务系统。该接口可用于收集客户的订单确认、问卷调查、满意度调查等信息。
QPS 限制
单用户调用频率:100 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
操作:是指具体的权限点。访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。资源类型:是指操作中支持授权的资源类型。具体说明如下:对于必选的资源类型,用前面加 * 表示。对于不支持资源级授权的操作,用全部资源表示。条件关键字:是指云产品自身定义的条件关键字。关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。操作访问级别资源类型条件关键字关联操作dyvms:IvrCallnone*全部资源
*
无无请求参数
名称类型必填描述示例值CalledShowNumberstring是主叫号码。
必须是已购买的号码,单次请求仅支持一个主叫号码。一般号码都有并发数,超过并发数会请求失败。您可以登录语音服务控制台,在语音号码>真实号管理页面查看已购买的号码。
0571****5678CalledNumberstring是被叫号码。
仅支持中国内地号码,单次请求仅支持一个号码。
1590****000StartCodestring是呼叫开始时播放的提示音。
语音文件:语音 ID。您可以登录语音服务控制台,在语音文件管理页面查看语音 ID。 文本转语音模板:模板 ID。您可以登录语音服务控制台,在语音消息>语音通知>文本转语音模板页面查看模板 ID。 TTS_1234****StartTtsParamsstring否文本转语音模板内的变量参数,格式为 JSON。
说明
当 StartCode 为文本转语音模板(TTS)且模板中带变量的情况下,此参数必填。
{"name":"xxx","code":"123"}PlayTimeslong否重复播放次数。取值范围为1~3。
3ByeCodestring否播放结束时播放的结束提示音。支持以下两种方式:
语音文件:语音 ID。您可以登录语音服务控制台,在语音文件管理页面查看语音 ID。 文本转语音模板:模板 ID。您可以登录语音服务控制台,在国内语音单呼>语音通知>文本转语音模板页面查看模板 ID。说明
参数 ByeCode 的类型需要与参数 StartCode 一致,即必须同时为语音文件或同时为文本转语音(TTS)模板。
TTS_1234****ByeTtsParamsstring否文本转语音模板中的变量参数。格式为 JSON。
说明
当 ByeCode 为文本转语音(TTS)模板且模板中带变量的情况下,此参数必填。
{"name":"xxx","code":"123"}Timeoutinteger否等待用户按键超时时间。单位:毫秒。
3000OutIdstring否预留给调用方使用的 ID。最终会通过在回执消息中将此 ID 带回给调用方。
字符串类型,长度为 1~15 个字节。
PR0210428****MenuKeyMaparray<object>是按键信息。
object是按键信息。
Keystring否被叫方可按的电话按键。
1TtsParamsstring否文本转语音模板内的变量参数,格式为 JSON。
说明
当MenuKeyMap.N.Code是文本转语音模板(TTS)时,对应的模板变量替换关系。 当MenuKeyMap.N.Code为文本转语音模板(TTS)且模板中带变量的情况下,此参数为必填。
{"name":"xxx","code":"123"}Codestring否MenuKeyMap.N.Key中指定按键对应的提示音。支持以下两种方式:
语音文件:语音 ID。您可以登录语音服务控制台,在语音文件管理页面查看语音 ID。 文本转语音模板:模板 ID。您可以登录语音服务控制台,在语音消息>语音通知>文本转语音模板页面查看模板 ID。 TTS_1235****返回参数
名称类型描述示例值object返回数据。
Codestring请求状态码。
返回 OK 代表请求成功。 其他错误码,请参见 API 错误码。 OKMessagestring状态码的描述。
OKRequestIdstring请求 ID。
D9CB3933-9FE3-4870-BA8E-2BEE91B69D23CallIdstring此次通话的唯一回执 ID。
CallId 可以通过 QueryCallDetailByCallId 接口查询指定通话的呼叫详情。
116012354148^10281378****示例
正常返回示例
JSON格式
{ "Code": "OK", "Message": "OK", "RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23", "CallId": "116012354148^10281378****" }
错误码
访问错误中心查看更多错误码。