更新任务（UpdateTask）--语音服务-火山引擎

文档中心

立即注册

导航

更新任务（UpdateTask）

最近更新时间：2023.08.17 20:59:18首次发布时间：2023.02.28 20:31:38

更新任务（UpdateTask）

更新任务信息

接口说明

请求方式：POST
接口地址：https://cloud-vms.volcengineapi.com?Action=UpdateTask&Version=2022-01-01

请求参数

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	是	UpdateTask	接口名称。该接口固定值为`UpdateTask`。
Version	String	是	2022-01-01	接口版本。

Body

参数	数据类型	是否必填	示例值	描述
TaskOpenId	String	是	123	任务唯一标识符
StartTime	String	是	2021-05-18 20:11:42	到了该时间任务开始执行
EndTime	String	是	2021-05-18 20:11:42	到了该时间任务停止执行
RingAgainTimes	Integer	否	1	重呼次数，默认0
RingAgainInterval	Integer	否	5	重呼间隔，最小5分钟，默认5
Concurrency	Integer	是	1	任务并发量，详见https://www.volcengine.com/docs/6358/69212
ForbidTimeList	List	否	[{"Times":["10:00-11:00"],"Weekdays":[3]}]	禁呼时间列表，ForbidTimeItem结构参照上方数据结构中的描述
Recall	Boolean	否	true	是否更新重呼设置，默认true

ForbidTimeItem

参数	数据类型	是否必填	示例值	描述
Weekdays	Set	否	[1,2]	1表示周日，2表示周一，以此类推，该参数不传代表每天都生效
Times	List	是	["09:00-10:00","15:00-16:00"]	禁呼时间段

返回参数

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

Result

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

请求示例

{
    "TaskOpenId":"123",
    "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"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"2021052017361001022509205912000B28",
        "Action":"UpdateTask",
        "Version":"2022-01-01",
        "Service":"vms",
        "Region":"cn-north-1"
    },
    "Result":{
        "TaskOpenId":"123"
    }
}