tencent cloud

Chat

DocumentationChat

Get Scheduled Task List

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

Description

This API is used to query the scheduled push task list with pagination. It supports sorting by creation time or scheduled time, time range filtering, and keyword search.

API Call Description

Sample Request URL

https://xxxxxx/v4/timpush/list_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/list_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,
    "Offset": 0,
    "Want": 20,
    "OrderBy": "schedat",
    "Asc": false,
    "BeginTime": "2025-05-01 00:00:00",
    "EndTime": "2025-06-01 00:00:00",
    "Keyword": "Push Title"
}

Request Body Field Description

Field
Type
Required
Description
Sdkappid
Integer
Yes
The SDKAppID of the application. Must match the sdkappid in the URL.
Offset
Integer
Yes
Pagination offset, starting from 0.
Want
Integer
Yes
Expected number of records to return. Must be greater than 0.
OrderBy
String
Yes
Sort field: createat to sort by creation time, schedat to sort by scheduled time.
Asc
Boolean
Yes
Sort direction. true for ascending, false for descending.
BeginTime
String
Yes
Start time of the query time range (UTC), format: YYYY-MM-DD HH:MM:SS.
EndTime
String
Yes
End time of the query time range (UTC), format: YYYY-MM-DD HH:MM:SS.
Keyword
String
No
Search keyword for fuzzy matching of task title or description.
Note:
BeginTime and EndTime must be set together, and BeginTime cannot be later than EndTime.
The time range cannot exceed the system-configured maximum number of days.

Sample Response Body

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "Total": 2,
    "Tasks": [
        {
            "TaskID": 1234567890,
            "Sdkappid": 88888888,
            "CreateAt": "2025-05-20 08:30:00",
            "Type": "All",
            "SchedAt": "2025-06-01 10:00:00",
            "Content": {
               "From_Account": "administrator",
               "MsgRandom": 985410822,
               "OfflinePushInfo": {
                    "Title": "Offline Push Title",
                    "Desc": "Offline Push Content"
                }
            },
            "Title": "Push Title 1",
            "Desc": "Push Description 1",
            "Status": "pending",
            "DispatchSuccess": 0,
            "DispatchErr": "",
            "PushTaskID": ""
        },
        {
            "TaskID": 1234567891,
            "Sdkappid": 88888888,
            "CreateAt": "2025-05-21 09:00:00",
            "Type": "Tag",
            "SchedAt": "2025-06-02 14:00:00",
            "Content": {
                "From_Account": "administrator",
                "MsgRandom": 2114286272,
                "Condition": {
                    "TagsAnd": [
                        "Stock A"
                    ]
                },
                "OfflinePushInfo": {
                    "Title": "Offline Push Title",
                    "Desc": "Offline Push Content"
                }
            },
            "Title": "Push Title 2",
            "Desc": "Push Description 2",
            "Status": "dispatched",
            "DispatchSuccess": 1,
            "DispatchErr": "",
            "PushTaskID": "69cf7344_537529d8_200003546b784eb_3a080d7b_5152250d"
        }
    ]
}

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.
Total
Integer
Total number of tasks matching the criteria (not affected by Offset and Want).
Tasks
Array
List of scheduled tasks. Each element is a TaskInfo object.

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.
Title
String
Push title.
Desc
String
Push description.
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.
PushTaskID
String
The push task ID generated after successful dispatch.

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 negative Offset, Want is 0, illegal OrderBy, incorrect time format, time range exceeded, sdkappid mismatch, etc.
90105
Internal error.

Next Topic: Política de Privacidade do

Help and Support

Was this page helpful?

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

Feedback