AI 助理
文档备案控制台
官方文档
首页 语音服务 开发参考 API参考 API目录 语音通话任务 CreateCallTask - 创建语音通话任务

CreateCallTask - 创建语音通话任务

更新时间：
复制 MD 格式
产品详情
我的收藏

使用服务实例给多个被叫号码创建文本转语音任务、语音通知任务和语音验证码任务。

接口说明

  • 此接口仅支持专属模式且通话号码需要使用已绑定真实号的服务实例，服务实例下未绑定真实号码时无法发起外呼。相关操作请参见真实号申请及创建服务实例。

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

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

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

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

QPS 限制

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dyvms:CreateCallTask

create

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
TaskName

string

否

通话的任务名称。

语音通知
BizType

string

否

语音模板类型。取值：

  • VMS_VOICE_TTS：语音通知文本转语音模板。

  • VMS_VOICE_CODE：语音通知文件模板。

  • VMS_TTS：语音验证码模板。

VMS_VOICE_CODE
TemplateCode

string

否

模板 Code。取值：

  • 如果是语音通知文本转语音模板，可以在语音服务控制台文本转语音模板页面获取模板 ID。

  • 如果是语音通知文件模板，可以在语音服务控制台语音通知文件页面获取语音 ID。

  • 如果是语音验证码模板，可以在语音服务控制台语音验证码页面获取模板 ID。

TTS_2122****
TemplateName

string

否

模板名称。取值：

  • 如果是语音通知文本转语音模板，可以在语音服务控制台文本转语音模板页面获取模板名称。

  • 如果是语音通知文件模板，可以在语音服务控制台语音通知文件页面获取语音文件名。

  • 如果是语音验证码模板，可以在语音服务控制台语音验证码页面获取模板名称。

语音通知模板
ResourceType

string

否

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

LIST
Resource

string

否

主叫号码，请传入服务实例 ID。目前仅支持已绑定真实号的服务实例，服务实例下未绑定真实号码无法发起通话任务。

您可以在语音服务控制台服务实例管理页面获取服务实例 ID 或绑定真实号码。

05516214****
DataType

string

否

被叫号码类型。取值：

  • LIST：LIST 格式用于无变量的文本转语音模板或语音文件。

  • JSON：JSON 格式用于内含变量参数的文本转语音模板。

JSON
Data

string

否

被叫号码或包含变量参数值的被叫数据。

  • 当 DataType 取值为 LIST 时，传入用英文半角逗号,分隔的被叫号码。填写格式示例187*****123,021****1234,177*****123。

  • 当 DataType 取值为 JSON 时，被叫号码及变量传参填写格式请参考示例值。示例值中paramNames对应文本转语音模板内的变量名，calleelist为被叫数据（callee对应被叫号码，params对应模板变量实际传值）。

说明

被叫号码为固话号码如021-12345678，应传入02112345678。

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

string

否

参数暂不可用。

1
StopTime

string

否

参数暂不可用。

1
ScheduleType

string

否

参数暂不可用。

1

返回参数

名称

类型

描述

示例值

object

返回数据。

Code

string

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码，请参见 API 错误码。

OK
Data

integer

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

18390**
RequestId

string

请求 ID。

ED815433-724A-4357-9991-A54AD2FF09FD

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Data": 0,
  "RequestId": "ED815433-724A-4357-9991-A54AD2FF09FD"
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidParameters The parameter is invalid. 无效参数

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

变更历史

更多信息，参考变更详情。

上一篇：语音通话任务下一篇：ListCallTask - 获取通话任务状态列表