All/Tagged Users Push Message Link
Feature Description
After enabling the Push service, call this API to view link data for all users/tag Push. This API supports data query within 7 days.
API Call Description
Sample Request URL
https://xxxxxx/v4/timpush/all_member_push_trace?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The following table lists only the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, refer to REST API introduction.
Parameter | Description |
xxxxxx | The dedicated domain name corresponding to the country/region where the SDKAppID resides. 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/all_member_push_trace | Request API |
sdkappid | The SDKAppID assigned by the IM console when creating an application |
identifier | |
usersig | The signature generated by the App administrator account. For specific operations, see generate UserSig. |
random | Enter a random 32-bit unsigned integer in the range of [0, 4294967295] |
contenttype | The request format is fixed as json . |
Maximum Calling Frequency
1 Times/second.
Sample Request Packet
{"TaskID":"xxx-yyy-zzz","UserID":"xyz"}
Request Packet Fields
Field | Type | Attribute | Description |
TaskID | String | Required | Query the push task TaskID. |
UserID | String | Required | Query the push receipt user UserID. |
Response Package Example
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "sucess","InstanceTrace": [{"InstanceId": "74224656","PushTime": "2025-03-13 16:16:27","DeviceModel": "","System": "Android","SystemVersion": "","EventType":1,"PushPlatform": 1,"Token": "aabbc","CertId": "1122","SdkVersion": "8.0.1","PushVersion": "8.0.1","NotificationStatus": 1,"last_active_terminal": 1,"IMCommitStat": {"IMStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"}},"OfflinePushStat": {"OfflineStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"},"ChannelStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"},"DeviceStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"},"ClickStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"}},"OnlinePushStat": {"ChannelStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"},"DeviceStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"}}}]}
Response Packet Fields
Field | Type | Description |
ActionStatus | String | Request processing result. OK: processing successful; FAIL: processing failed. |
ErrorCode | Integer | Error code. 0 indicates success, non-0 indicates failure. |
ErrorInfo | String | Error message. |
InstanceTrace | Array | Organize link data push for each IM instance. |
InstanceId | String | IM instance identifier. |
PushTime | String | Push task time. |
DeviceModel | String | device model |
System | String | device system. |
SystemVersion | String | Device system version. |
EventType | Integer | 1=offline push; 2=online push. |
PushPlatform | Integer | Push vendor (online push EventType = 2 is case-insensitive, default return 0): PushPlatform = 0 means unknown vendor PushPlatform = 1 means Apple APNS push PushPlatform = 2 means Mi Push PushPlatform = 3 means Huawei Push PushPlatform = 4 means Google FCM push PushPlatform = 5 means Meizu Push PushPlatform = 6 means OPPO push PushPlatform = 7 means vivo push PushPlatform = 8 means HONOR Push |
Token | String | Manufacturer Token. |
CertId | String | certificate ID |
SdkVersion | String | SDK version number. |
PushVersion | String | Push the plugin version number. |
NotificationStatus | Integer | Notification bar status is enabled. |
LastActiveTerminal | Integer | Whether the IM instance was recently activated. |
IMCommitStat | Object | Submit the IM server status. |
IMStat | Object | IM status. |
OfflinePushStat | Object | Offline channel status. |
OfflineStat | Object | Submit the offline channel status. |
ChannelStat | Object | Submit the manufacturer channel status. |
DeviceStat | Object | Message push to device status. |
ClickStat | Object | User click status. |
OnlinePushStat | Object | Online channel status. |
ChannelStat | Object | Submit the manufacturer channel status. |
DeviceStat | Object | Message push to device status. |
PushStatus | Integer | success or failure, 1 indicates success, 2 indicates failure. |
ErrorCode | Integer | Failure error code. |
ErrorInfo | String | Error description. |
EventTime | String | Event sending time. |
Error Code Description
Unless a network error occurs (such as a 502 error), the HTTP return code of this API is 200. The actual error code and error information are indicated by ResultCode, ResultInfo, ErrorCode, and ErrorInfo in the response payload.
Private error codes of this API are as follows:
Error Code | Description |
91000 | Request error. According to the error prompt, troubleshoot the problem. |
90009 | The request lacks permissions. Use the administrator to call. |
90045 | The service is not enabled. Ensure the service is turned on. |
90100 | Invalid request parameters. Check parameters and verify the validity of them according to the documentation. |
90102 | Internal error, please try again later. |
90103 | Failed to switch accounts. Please check and verify the validity of the UserID. |