功能说明
本接口用于删除一个已创建的定时推送任务。仅支持删除状态为“待执行”(pending)的任务,已在调度中或已调度完成的任务无法删除。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/timpush/delete_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/delete_sched_task | 请求接口。 |
usersig | |
identifier | |
sdkappid | 创建应用时即时通信控制台分配的 SdkAppid。 |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 固定值为: json。 |
调用频率限制
每秒5次。
请求包示例
{"Sdkappid": 88888888,"TaskID": 1234567890,"Type": "All"}
请求包字段说明
字段 | 类型 | 必填 | 说明 |
Sdkappid | Integer | 是 | 应用的 SDKAppID,必须与 URL 中的 sdkappid 一致。 |
TaskID | Integer | 是 | 定时任务 ID,创建任务时返回的 TaskID。 |
Type | String | 是 | 推送任务类型: All 代表全员推送,Tag 代表标签推送,User 代表单发推送。 |
应答包体示例
删除成功
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"TaskID": 1234567890}
删除失败
{"ActionStatus": "FAIL","ErrorInfo": "delete 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 不合法、sdkappid 不匹配等。 |
90105 | 内部错误。 |
90106 | 任务已调度完成,无法删除。 |
90107 | 任务正在调度中,无法删除。 |