VoiceSingleCall_语音服务_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.

流控信息

当前云产品API请求速率暂未透出。

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
暂无数据

请求参数

字段名称字段详情
CallerIdNumberstring

主叫号码。 若您不填该参数,系统将会使用当地随机号码作为外显号码。 若您专属号码外呼,则必须传入已购买的号码,仅支持一个号码。您可以登录国际语音服务控制台,选择"号码管理"查看已购买的号码。

示例值:852****0001
CalledNumberstring

接收语音通知的手机号码。 号码格式:国际码+号码: 示例:85200****00。

示例值:852****0000
TtsCodestring

文本转语音模板的语音 ID。 您可以登录国际语音服务控制台,选择"语音模板管理"-"文本转语音模板",查看模板 ID。 此参数与 VoiceCode 二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。

示例值:1001
TtsParamstring

模板中的变量参数,JSON 格式。

示例值:{"code":"1234"}
VoiceCodestring

语音文件的模板 ID。 您可以登录国际语音服务控制台,选择"语音模板管理"-"语音文件",查看模板 ID。 此参数与 TtsCode 二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。

示例值:1002
PlayTimesinteger<int64>

一通电话内语音通知内容的播放次数。取值范围:1~3,默认取值 3。

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

语音通知的播放音量。取值范围:0~100,默认取值 100。

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

语速控制。取值范围为:-500~500。

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

任务名称。

示例值:单呼任务名
SendTypeinteger<int64>

发送类型:取值[1,2]。 1: 立即开始发送任务,不等待。 2: 定时开始发送任务。如果传该类型,TimingStart 为必选字段。

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

定时发送的时间。

示例值:2022-05-01T08:00:00+08:00
OutIdstring

预留给调用方使用的 ID,最终会通过在回执消息中将此 ID 带回给调用方。 字符串类型,长度为 1~15 个字节。

示例值:22522****
CountryIdstring

国家/地区二字码,ISO2。

示例值:HK

返回参数

字段名称字段详情
AccessDeniedDetailstring

访问被拒绝详细信息。

示例值:""
Messagestring

返回信息描述。

示例值:OK
RequestIdstring

请求 ID。

示例值:D9CB****-****-****-****-********9D23
Modelobject

请求结果数据

Codestring

请求状态码。 返回 OK 代表请求成功。 其他错误码,请参见 API 错误码。

示例值:OK
Successboolean

请求是否成功,成功:true,失败:false。

示例值:true

返回示例

变更历史

变更时间变更内容概要操作
2024-12-23
新增OpenAPI,向指定号码发起语音呼叫

相关示例