CreateCallTask - 创建语音通话任务

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

接口说明

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

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

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

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

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

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dyvms:CreateCallTaskcreate
*全部资源
*

请求参数

名称类型必填描述示例值
TaskNamestring

通话的任务名称。

语音通知
BizTypestring

语音模板类型。取值:

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

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

  • VMS_TTS:语音验证码模板。

VMS_VOICE_CODE
TemplateCodestring

模板 Code。取值:

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

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

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

TTS_2122****
TemplateNamestring

模板名称。取值:

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

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

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

语音通知模板
ResourceTypestring

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

LIST
Resourcestring

主叫号码。目前仅支持虚拟号码。

您可以在语音服务控制台虚拟号管理页面获取虚拟号码。

05516214****
DataTypestring

被叫号码类型。取值:

  • LIST:LIST 格式用于无变量的文本转语音模板或语音文件。
  • JSON:JSON 格式用于内含变量参数的文本转语音模板。
JSON
Datastring

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

  • 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":["李四","天猫订单"] } ] }
FireTimestring

参数暂不可用。

1
StopTimestring

参数暂不可用。

1
ScheduleTypestring

参数暂不可用。

1

返回参数

名称类型描述示例值
object

返回数据。

Codestring

请求状态码。

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

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

18390**
RequestIdstring

请求 ID。

ED815433-724A-4357-9991-A54AD2FF09FD

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParametersThe parameter is invalid.无效参数

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

变更历史

变更时间变更内容概要操作
暂无变更历史