You need to enable JavaScript to run this app.
导航
语音服务
  • 文档首页
    • /
  • 语音服务

更新任务（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-DateString是20201103T104027Z鉴权字段。请参考文档中心-火山引擎。

Authorization

String

是

HMAC-SHA256 Credential***

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

ServiceNameString是vms服务名称。语音服务的服务名称为vms。
RegionString是cn-north-1区域名称。
Content-TypeString是application/json指定请求消息体的结构化格式。

Query

参数数据类型是否必填示例值描述
ActionString是UpdateTask接口名称。该接口固定值为UpdateTask。
VersionString是2022-01-01接口版本。

Body

参数数据类型是否必填示例值描述
TaskOpenIdString是123任务唯一标识符
StartTimeString是2021-05-18 20:11:42到了该时间任务开始执行
EndTimeString是2021-05-18 20:11:42到了该时间任务停止执行
RingAgainTimesInteger否1重呼次数，默认0
RingAgainIntervalInteger否5重呼间隔，最小5分钟，默认5
ConcurrencyInteger是1任务并发量，详见https://www.volcengine.com/docs/6358/69212

ForbidTimeList

List

否

[{"Times":["10:00-11:00"],"Weekdays":[3]}]

禁呼时间列表，ForbidTimeItem结构参照上方数据结构中的描述

RecallBoolean否true是否更新重呼设置，默认true

ForbidTimeItem

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

Weekdays

Set

否

[1,2]

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

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

返回参数

参数数据类型描述
ResponseMetadataResponseMetadata见 ResponseMetadata
ResultResult见下方

Result

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

请求示例

{
    "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"
    }
}