You need to enable JavaScript to run this app.
导航
创建任务(CreateTask)
最近更新时间:2023.12.13 14:53:22首次发布时间:2023.02.28 20:31:38

创建任务(CreateTask)

创建呼叫任务

接口说明

  • 请求方式:POST

  • 接口地址:https://cloud-vms.volcengineapi.com?Action=CreateTask&Version=2022-01-01

  • 注意事项:同时在运行中的任务数量不超过50,如果特殊需求请联系单独配置

请求参数

Header

参数数据类型是否必填示例值描述
X-DateString20201103T104027Z鉴权字段。请参考文档中心-火山引擎

Authorization

String

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎

ServiceNameStringvms服务名称。语音服务的服务名称为vms
RegionStringcn-north-1区域名称。
Content-TypeStringapplication/json指定请求消息体的结构化格式。

Query

参数数据类型是否必填示例值描述
ActionStringCreateTask接口名称。该接口固定值为CreateTask
VersionString2022-01-01接口版本。

Body

参数数据类型是否必填示例值描述
NameStringtask1任务名称

PhoneList

List

[{"Phone":"15233345567"}]

号码列表,参照数据结构中PhoneParam描述,单次最多1w条

ResourceString3cf1c12fc6c842faa451b23ad02324f1话术资源id,比如语音文件id、tts模版id、IVR流程id
NumberPoolNoStringNP160084061100694433号码池编号
NumberListList["13344445555","13255556666"]选出用于拨打的主叫号码,SelectNumberType为1时必须传值

StartTime

String

2021-05-18 20:11:42

到了该时间任务开始执行

EndTimeString2021-05-18 20:11:42到了该时间任务停止执行
StartBooleantrue任务是否自动开始
MaxRingDurationInteger20最大响铃时长
RingAgainTimesInteger1重呼次数,默认0
RingAgainIntervalInteger5重呼间隔,最小5分钟,默认5
ConcurrencyInteger1任务并发量,详见https://www.volcengine.com/docs/6358/69212
FinishWhenListEndBooleanfalse是否列表拨打完任务就结束,默认false不结束
UniqueBooleanfalse是否开启号码去重,默认false不去重
ForbidTimeListList[{"Times":["10:00-11:00"],"Weekdays":[3]}]禁呼时间列表,ForbidTimeItem结构参照上方数据结构中的描述

SelectNumberType

Integer

0

号码池选号选择情况,0代表从整个号码池选号, 1代表从NumberList中选号,按照号码选号时需要设置,按照规则选号不设置该值

Type

Integer

0

任务类型(0录音文件, 1TTS模板,2IVR流程,3TTS)

SelectNumberRuleInteger5选号规则,目前仅支持传5(强烈推荐传该值),优先按照被叫号码归属地选号,如果没有选到降级到同省会,无同省会号码,默认降级到北京、上海、广州再选,如果还是没有选到,最后按照号码池随机选择一个号码
CallRecordPostUrlString"http:xxx"话单推送地址
AudioPostUrlString"http:xxx"录音推送地址
ModeInteger0任务模式,0 普通任务,1 固话拨测,2 AXB拨测

SmsConfig

List

[{"TemplateId":"xxxxx","Sign":"xxxxxx","StatusSet":[1,2,3]}]

挂机短信配置,当配置了话术并且拥有通过审核的签名和模板后可以进行配置
注意:审核通过后有5分钟左右延迟,这期间使用模板或签名可能报错不存在

PhoneParam

参数数据类型是否必填示例值描述
PhoneString15277889900手机号码

PhoneParam

Map<String, Object>

{"key1":"test1"}

变量参数,TTS模板类型、IVR流程类型需要

TtsContentString你好啊TTS文本,TTS类型任务需要,长度限制250
ExtString用户自定义参数,长度限制250

SmsParam

Map<String,String>

{"name":"张三"}

挂机短信模板参数,会和 PhoneParam 中的参数合并,如果重复以 SmsParam 为准。
例子:
PhoneParam 配了 {"k1": "p1", "k2": "p2"}
SmsParam 配了
{"k1": "s1", "k3": "s3"}
最终 SmsParam 会变成:
{"k1": "s1", "k2": "p2", "k3": "s3"}

ForbidTimeItem

参数数据类型是否必填示例值描述

Weekdays

Set

[1,2]

1表示周日,2表示周一,以此类推,该参数不传代表每天都生效

TimesList["09:00-10:00","15:00-16:00"]禁呼时间段

SmsConfigItem

参数数据类型是否必填示例值描述

TemplateId

String

"ST_712d9312"

模板id

SignString"测试"签名内容

StatusSet

Set

[1,2,3,4]

呼叫状态,1 已接通,2 未接通,3 呼叫失败,4 未拨打

返回参数

参数数据类型描述
ResponseMetadataResponseMetadataResponseMetadata
ResultResult见下方

Result

参数数据类型示例值描述
TaskOpenIdString122333任务唯一标识符

FailList

List

["Index":0,"Phone":"15233334444"]

添加失败的号码

FailItem

参数数据类型示例值描述
IndexInteger0失败项索引
PhoneString"15233334444"失败项的号码
TypeString"NO_PERMISSION"失败项的失败类型,也即错误码

请求示例

{
    "Name":"task1",
    "Resource":"e1412fe09be840e4a35c0633331a475d",
    "NumberList":[
        "057156199918"
    ],
    "Concurrency":1,
    "ForbidTimeList":[
        {
            "Weekdays":[
                1
            ],
            "Times":[
                "10:00-11:00"
            ]
        }
    ],
    "RingAgainTimes":1,
    "RingAgainInterval":5,
    "EndTime":"2021-05-21 17:35:44",
    "StartTime":"2021-05-20 17:35:43",
    "PhoneList":[
        {
            "Phone":"17052992739"
        }
    ],
    "Unique":true,
    "NumberPoolNo":"NP161268484610905956"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"CreateTask",
        "Version":"2022-01-01",
        "Service":"vms",
        "Region":"cn-north-1"
    },
    "Result":{
        "TaskOpenId":"77",
        "FailList":[

        ]
    }
}