IvrCall_云通信语音服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 提交企业资质,并审核通过。具体操作,请参见提交企业资质

  • 购买语音号码。具体操作,请参见购买号码

  • 用户接听电话后会听到一段语音,提示用户按键选择。如果开启了消息回执,语音服务会将客户按键信息返回给调用的业务系统。该接口可用于收集客户的订单确认、问卷调查、满意度调查等信息。

QPS 限制

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

流控信息

请求速率为1000/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dyvms:IvrCall
None
全部资源
*

请求参数

字段名称字段详情
CalledShowNumberstring

主叫号码。展开详情

示例值:0571****5678
CalledNumberstring

被叫号码。展开详情

示例值:1590****000
StartCodestring

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

示例值:TTS_1234****
StartTtsParamsstring

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

示例值:{"name":"xxx","code":"123"}
PlayTimesinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:3
ByeCodestring

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

示例值:TTS_1234****
ByeTtsParamsstring

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

示例值:{"name":"xxx","code":"123"}
Timeoutinteger<int32>

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

示例值:3000
OutIdstring

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

示例值:PR0210428****
MenuKeyMaparray<object>

按键信息。

子级条数 <= 15

返回参数

字段名称字段详情
Codestring

请求状态码。展开详情

示例值:OK
Messagestring

状态码的描述。

示例值:OK
RequestIdstring

请求 ID。

示例值:D9CB3933-9FE3-4870-BA8E-2BEE91B69D23
CallIdstring

此次通话的唯一回执 ID。展开详情

示例值:116012354148^10281378****

返回示例

变更历史

暂无变更历史

相关示例

通过OpenAPI 交互式语音通话并查询状态
2022-02-08