tencent cloud

Chat

DocumentationChatPush ServiceREST APIScheduled Task APIGet Scheduled Task Details

Get Scheduled Task Details

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

Description

This API is used to query the detailed information of a single scheduled push task by task ID, including task status, scheduled time, push content, etc.

API Call Description

Sample Request URL

https://xxxxxx/v4/timpush/get_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/get_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
}

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.

Sample Response Body

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "TaskInfo": {
        "TaskID": 1234567890,
        "Sdkappid": 88888888,
        "CreateAt": "2025-05-20 08:30:00",
        "Type": "All",
        "SchedAt": "2025-06-01 10:00:00",
        "Content": {
            "From_Account": 12345,
            "MsgRandom": 123456,
            "OfflinePushInfo": {
                "Title": "Push Title",
                "Desc": "Push Content Description"
            }
        },
        "Title": "Push Title",
        "Desc": "Push Content Description",
        "Status": "pending",
        "DispatchSuccess": 0,
        "DispatchErr": "",
        "PushTaskID": ""
    }
}

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.
TaskInfo
Object
Detailed information of the scheduled task. See the table below.

TaskInfo Field Description

Field
Type
Description
TaskID
Integer
Scheduled task ID.
Sdkappid
Integer
The SDKAppID of the application.
CreateAt
String
Task creation time (UTC), format: YYYY-MM-DD HH:MM:SS.
Type
String
Push task type: `All` (push to all users), Tag (tag-based push), User (single-user push).
SchedAt
String
Scheduled time (UTC), format: YYYY-MM-DD HH:MM:SS.
Content
Object
Push task content. The structure is the same as the Content provided at creation.
Title
String
Push title, extracted from Content.OfflinePushInfo.Title.
Desc
String
Push description, extracted from Content.OfflinePushInfo.Desc.
Status
String
Task status: pending (awaiting execution), dispatching (dispatching in progress), dispatched (dispatched).
DispatchSuccess
Integer
Whether the dispatch was successful: 0 indicates not successful or not dispatched, 1 indicates dispatch successful.
DispatchErr
String
Error message when dispatch fails. Empty when dispatch is successful or not yet dispatched.
PushTaskID
String
The push task ID generated after successful dispatch. Can be used to query push results.

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, sdkappid mismatch, etc.
90105
Internal error.
Previous Topic: Delete Scheduled TaskNext Topic: Get Scheduled Task List

Help and Support

Was this page helpful?

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

Feedback