文档中心

创建任务（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-Date	String	是	20201103T104027Z	鉴权字段。请参考文档中心-火山引擎。
Authorization	String	是	HMAC-SHA256 Credential***	鉴权字段。请参考文档中心-火山引擎。
ServiceName	String	是	vms	服务名称。语音服务的服务名称为`vms`。
Region	String	是	cn-north-1	区域名称。
Content-Type	String	是	application/json	指定请求消息体的结构化格式。

Query

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

Body

参数	数据类型	是否必填	示例值	描述
Name	String	是	task1	任务名称
PhoneList	List	否	[{"Phone":"15233345567"}]	号码列表，参照数据结构中PhoneParam描述，单次最多1w条
Resource	String	是	3cf1c12fc6c842faa451b23ad02324f1	话术资源id，比如语音文件id、tts模版id、IVR流程id
NumberPoolNo	String	是	NP160084061100694433	号码池编号
NumberList	List	否	["13344445555","13255556666"]	选出用于拨打的主叫号码，SelectNumberType为1时必须传值
StartTime	String	是	2021-05-18 20:11:42	到了该时间任务开始执行
EndTime	String	是	2021-05-18 20:11:42	到了该时间任务停止执行
Start	Boolean	否	true	任务是否自动开始
MaxRingDuration	Integer	否	20	最大响铃时长
RingAgainTimes	Integer	否	1	重呼次数，默认0
RingAgainInterval	Integer	否	5	重呼间隔，最小5分钟，默认5
Concurrency	Integer	是	1	任务并发量，详见https://www.volcengine.com/docs/6358/69212
FinishWhenListEnd	Boolean	否	false	是否列表拨打完任务就结束，默认false不结束
Unique	Boolean	否	false	是否开启号码去重，默认false不去重
ForbidTimeList	List	否	[{"Times":["10:00-11:00"],"Weekdays":[3]}]	禁呼时间列表，ForbidTimeItem结构参照上方数据结构中的描述
SelectNumberType	Integer	否	0	号码池选号选择情况，0代表从整个号码池选号, 1代表从NumberList中选号，按照号码选号时需要设置，按照规则选号不设置该值
Type	Integer	是	0	任务类型（0录音文件, 1TTS模板，2IVR流程，3TTS）
SelectNumberRule	Integer	否	5	选号规则，目前仅支持传5（强烈推荐传该值），优先按照被叫号码归属地选号，如果没有选到降级到同省会，无同省会号码，默认降级到北京、上海、广州再选，如果还是没有选到，最后按照号码池随机选择一个号码
CallRecordPostUrl	String	否	"http:xxx"	话单推送地址
AudioPostUrl	String	否	"http:xxx"	录音推送地址
Mode	Integer	否	0	任务模式，0 普通任务，1 固话拨测，2 AXB拨测
SmsConfig	List	否	[{"TemplateId":"xxxxx","Sign":"xxxxxx","StatusSet":[1,2,3]}]	挂机短信配置，当配置了话术并且拥有通过审核的签名和模板后可以进行配置注意：审核通过后有5分钟左右延迟，这期间使用模板或签名可能报错不存在

PhoneParam

参数	数据类型	是否必填	示例值	描述
Phone	String	是	15277889900	手机号码
PhoneParam	Map<String, Object>	否	{"key1":"test1"}	变量参数，TTS模板类型、IVR流程类型需要
TtsContent	String	否	你好啊	TTS文本，TTS类型任务需要，长度限制250
Ext	String	否		用户自定义参数，长度限制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表示周一，以此类推，该参数不传代表每天都生效
Times	List	是	["09:00-10:00","15:00-16:00"]	禁呼时间段

SmsConfigItem

参数	数据类型	是否必填	示例值	描述
TemplateId	String	是	"ST_712d9312"	模板id
Sign	String	是	"测试"	签名内容
StatusSet	Set	是	[1,2,3,4]	呼叫状态，1 已接通，2 未接通，3 呼叫失败，4 未拨打

返回参数

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	见 ResponseMetadata
Result	Result	见下方

Result

参数	数据类型	示例值	描述
TaskOpenId	String	122333	任务唯一标识符
FailList	List	["Index":0,"Phone":"15233334444"]	添加失败的号码

FailItem

参数	数据类型	示例值	描述
Index	Integer	0	失败项索引
Phone	String	"15233334444"	失败项的号码
Type	String	"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":[

        ]
    }
}

创建任务（CreateTask）

接口说明

请求参数

返回参数

请求示例

返回示例

语音服务

创建任务（CreateTask）

创建任务（CreateTask）

接口说明

请求参数

Header

Query

Body

PhoneParam

ForbidTimeItem

SmsConfigItem

返回参数

Result

FailItem

请求示例

返回示例