tencent cloud

Chat

DocumentationChatPush ServiceREST APIScheduled Task APIDelete Scheduled Task

Delete Scheduled Task

PDF
Focus Mode
Font Size
Last updated: 2026-04-13 17:35:38

Description

This API is used to delete a previously created scheduled push task. Only tasks with "pending" status can be deleted. Tasks that are currently dispatching or have already been dispatched cannot be deleted.

API Call Description

Sample Request URL

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

Request parameters

Parameter
Description
https
The request protocol is: HTTPS
Request method: POST
xxxxxx
The dedicated domain corresponding to the country/region of your SDKAppID.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/timpush/delete_sched_task
Request API
usersig
The Signature generated by the App admin account. For details, see Generating UserSig
identifier
You must be an App admin account. For more details, see App Admins
sdkappid
SdkAppid assigned by the Instant Messaging Console when an application is created
random
A random 32-bit unsigned integer ranging from 0 to 4294967295
contenttype
Fixed value: json

Call frequency limit

5 requests per second.

Sample Request Body

{
    "Sdkappid": 88888888,
    "TaskID": 1234567890,
    "Type": "All"
}

Request Body Field Description

Field
Type
Required
Description
Sdkappid
Integer
Yes
The SDKAppID of the application. Must match the sdkappid in the URL.
TaskID
Integer
Yes
The scheduled task ID returned when the task was created.
Type
String
Yes
Push task type: All for push to all users, Tag for tag-based push, User for single-user push.

Sample Response Body

Successful deletion
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "TaskID": 1234567890
}
Failed deletion
{
    "ActionStatus": "FAIL",
    "ErrorInfo": "delete failed: task dispatching",
    "ErrorCode": 90107,
    "TaskID": 0
}

Response Body Field Description

Field
Type
Description
ActionStatus
String
The result of the request. OK indicates success, FAIL indicates failure.
ErrorCode
Integer
Error code. 0 indicates success, non-0 indicates failure.
ErrorInfo
String
Error message.
TaskID
Integer
The ID of the deleted scheduled task.

Error Codes

Unless a network error occurs (e.g. 502 error), the HTTP return code of this API is always 200. The actual error code and error message are indicated by ErrorCode and ErrorInfo in the response body. For common error codes (60000 to 79999), see the Error Codes documentation.
The private error codes for this API are as follows:
Error Code
Description
90104
Invalid request parameters, such as invalid TaskID, illegal Type, sdkappid mismatch, etc.
90105
Internal error.
90106
Task has already been dispatched and cannot be deleted.
90107
Task is currently dispatching and cannot be deleted.

Previous Topic: Update Scheduled TaskNext Topic: Get Scheduled Task Details

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback