CreateCallTask_云通信语音服务_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.

接口说明

  • 此接口仅支持专属模式外呼且外呼号码需要使用虚拟号码,相关操作请参见真实号申请创建虚拟号

  • 如需使用公共模式实现批量外呼,可多次调用 SingleCallByVoiceSingleCallByTts 接口,每一次调用仅支持给单个被叫号码发送语音通知或语音验证码。

  • 通话任务创建完成后,请使用 ExecuteCallTask 接口执行通话任务。您也可以在语音服务控制台任务中心页面执行通话任务。

  • 使用此接口创建一次通话任务,最多支持创建 1000 条语音通知任务。

  • 为保证用户良好的外呼体验,每天 12:00 至 14:00,21:00 至次日 09:00 时间段内无法执行语音通话任务。如您的业务场景需要保证全天候时间段内可外呼,可使用无时段限制的 SingleCallByVoiceSingleCallByTts 接口。

QPS 限制

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

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
TaskNamestring

通话的任务名称。

示例值:语音通知参考取值来源:
    CreateRobotTask
    ListCallTask
BizTypestring

语音模板类型。取值:展开详情

示例值:VMS_VOICE_CODE
TemplateCodestring

模板 Code。取值:展开详情

示例值:TTS_2122****
TemplateNamestring

模板名称。取值:展开详情

示例值:语音通知模板
ResourceTypestring

主叫号码类型。固定取值:LIST

示例值:LIST
Resourcestring

主叫号码。目前仅支持虚拟号码。展开详情

示例值:05516214****
DataTypestring

被叫号码类型。取值:展开详情

示例值:JSON
Datastring

被叫号码或包含变量参数值的被叫数据。展开详情

示例值:{ "paramNames":["name",,"key"], "calleeList":[ { "callee":"1310000****", "params":["张三","淘宝订单"] }, { "callee":"1320000****", "params":["李四","天猫订单"] } ] }
FireTimestring

参数暂不可用。

示例值:1
StopTimestring

参数暂不可用。

示例值:1
ScheduleTypestring

参数暂不可用。

示例值:1

返回参数

字段名称字段详情
Codestring

请求状态码。展开详情

示例值:OK
Datainteger<int64>

任务 ID。使用此任务 ID,通过 ExecuteCallTask 接口执行通话任务。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:18390**
RequestIdstring

请求 ID。

示例值:ED815433-724A-4357-9991-A54AD2FF09FD

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParameters
The parameter is invalid.诊断

变更历史

变更时间变更内容概要操作
2022-02-16
变更错误码400

相关示例

通过OpenAPI创建通话任务并查询任务详情
2022-02-16
2024年08月20日