修改定时任务

最近更新时间:2026-04-07 16:52:19

我的收藏

功能说明

本接口用于修改一个已创建的定时推送任务。支持修改调度时间、推送内容等字段。仅支持修改状态为"待执行"(pending)的任务,已在调度中或已调度完成的任务无法修改。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/timpush/modify_sched_task?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json

请求参数说明

参数
说明
https
请求协议为:HTTPS。
请求方式为:POST。
xxxxxx
SDKAppID 所在国家/地区对应的专属域名。
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
首尔: adminapikr.im.qcloud.com
法兰克福:adminapiger.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/timpush/modify_sched_task
请求接口。
usersig
App 管理员账号生成的签名,参见 UserSig 后台 API
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员。
sdkappid
创建应用时即时通信控制台分配的 SdkAppid。
random
请输入随机的32位无符号整数,取值范围0 - 4294967295。
contenttype
固定值为:json

调用频率限制

每秒5次。

请求包示例

修改调度时间
{
"Sdkappid": 88888888,
"TaskID": 1234567890, // 创建任务时返回的 TaskID
"Type": "All",
"SchedAt": "2025-06-15 14:00:00"
}
修改推送内容
{
"Sdkappid": 88888888,
"TaskID": 1234567890,
"Type": "All",
"Content": {
"OfflinePushInfo": {
"Title": "新的推送标题",
"Desc": "新的推送内容描述"
}
}
}
同时修改多个字段
{
"Sdkappid": 88888888,
"TaskID": 1234567890,
"Type": "All",
"SchedAt": "2025-07-01 09:00:00",
"Content": {
"OfflinePushInfo": {
"Title": "更新后的标题",
"Desc": "更新后的描述"
}
}
}

请求包字段说明

字段
类型
必填
说明
Sdkappid
Integer
应用的 SDKAppID,必须与 URL 中的 sdkappid 一致。
TaskID
Integer
定时任务 ID,创建任务时返回的 TaskID。
Type
String
推送任务类型:All 代表全员推送,Tag 代表标签推送,User 代表单发推送。Type 必须与创建时一致,不支持修改任务类型。
SchedAt
String
定时调度时间,格式为:YYYY-MM-DD HH:MM:SS(UTC 时间)。不传则不修改。
Content
Object
推送任务内容。不传则不修改。如果传入,结构需与创建时的 Type 对应的内容格式一致。
注意:
SchedAt、Content 两个字段至少需要传入一个。如果传入 Content,系统会重新校验内容合法性,并重新提取 Title 和 Desc。

应答包体示例

修改成功
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"TaskID": 1234567890
}
修改失败
{
"ActionStatus": "FAIL",
"ErrorInfo": "modify failed: task dispatching",
"ErrorCode": 90107,
"TaskID": 0
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果,OK 表示处理成功,FAIL 表示失败。
ErrorCode
Integer
错误码,0 表示成功,非 0 表示失败。
ErrorInfo
String
错误信息。
TaskID
Integer
被修改的定时任务 ID。

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码
说明
90104
请求参数无效,例如 TaskID 无效、Type 不合法、SchedAt 格式错误、sdkappid 不匹配、任务类型与内容不匹配等。
90105
内部错误。
90106
任务已调度完成,无法修改。
90107
任务正在调度中,无法修改。
90110
调度时间无效(例如调度时间已过期)。