tencent cloud

Chat

News and Announcements
Release Notes
Announcements
Product Introduction
Overview
Basic Concepts
Scenarios
Features
Account System
User Profile and Relationship Chain
Message Management
Group Related
Official Account
Audio/Video Call
Use Limits
Purchase Guide
Billing Overview
Pricing
Purchase Instructions
Renewal Guide
Service Suspension Explanation
Refund Policy
Development Guidelines
Demo Zone
Activate Service
Free Demos
Quick Run
Download
SDK and Demo Source Code
Update Log
Chat Interaction (UI Included)
TUIKit Introduction
Getting Started
Full-feature Integration
Single-function Integration
Build with AI
Build Basic Interfaces
More Features
Customizing Appearance
Internationalization
Push Service
Overview
Noun explanation
Activate the Service
Quick Start
Manufacturer Channel
Statistics
Troubleshooting Tool
Client APIs
REST API
Push Callback
Advanced Features
Release Notes
Error Codes
FAQS
Desk
Overview
Quick Start
Integration Guide
Admin Operation Manual
Agent Manual
More Practices
Live Streaming Setup Guide
AI Chatbot
Super Large Entertainment and Collaboration Community
Discord Implementation Guide
How to Integrate Chat into Games
WhatsApp Channel-style Official Account Integration Solution
Send Red Packet
Firewall Restrictions
No UI Integration
Quick Start
SDK Integration
Initialization
Login and Logout
Message
Conversation
Group
Community Topic
User Profile and Relationship Chain
Offline Push
Cloud Search
Local Search
Official Channel Management
Client APIs
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
Server APIs
Secure authentication with UserSig
RESTful APIs
Webhooks
Console Guide
New Console Introduction
Creating and Upgrading an Application
Basic Configuration
Feature Configuration
Account Management
Group Management
Official Channel Management
Webhook Configuration
Usage
Viewing Guide for Resource Packages
Real-Time Monitor
Auxiliary Development Tools
Access Management
Advanced Features
FAQs
uni-app FAQs
Purchase
SDK
Account Authentication
User Profile and Relationship Chain
Message
Group
Audio-Video Group
Nickname and Profile Photo
Security Compliance Certification
Service Level Agreement
Security Compliance Certification
Chat Policies
Privacy Policy
Data Privacy and Security Agreement
Migration
Migration Solutions
Migration Solutions Lite
Error Codes
Contact Us
DocumentationChatPush ServiceREST APIStatistics APIChat Service Push Message Link

Chat Service Push Message Link

PDF
Focus Mode
Font Size
Last updated: 2025-07-17 14:43:28

Feature Description

After enabling the Push service, call this API to view link data for Chat single/group chat message Push. This API supports data query within 7 days.

API Call Description

Sample Request URL

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

Request Parameters

The following table lists only the parameters involved in modification and their descriptions when calling this API. For more details about the parameters, refer to REST API introduction.
Parameter
Description
xxxxxx
The dedicated domain name for 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/normal_push_trace
Request API
sdkappid
SDKAppID assigned by the IM console when creating an application
identifier
Must be an App administrator account. For more details, see app admin.
usersig
The signature generated by the App administrator account. For details, see generate UserSig.
random
Enter a random 32-bit unsigned integer, value ranges from 0 to 4294967295.
contenttype
The request format is fixed as json.

Maximum Calling Frequency

1 time/second

Sample Request Packet

{
    "PushID":"xxx-yyy-zzz"
}


Request Packet Fields

Field
Type
Attribute
Description
PushID
String
Required
The MsgID of the push message.

Response Package Example

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "sucess",
    "InstanceTrace": [
        {
            "InstanceId": "101205908",
            "PushTime": "2025-03-07 10:04:47",
            "DeviceModel": "",
            "System": "APNS",
            "SystemVersion": "",
            "PushPlatform": 1,
            "Token": "",
            "CertId": "0",
            "SdkVersion": "",
            "PushVersion": "",
            "NotificationStatus": 0,
            "last_active_terminal": 1,
            "IMCommitStat": {
                "IMStat": {
                    "PushStatus": 1,
                    "ErrorCode": 0,
                    "ErrorInfo": "success",
                    "EventTime": "2025-03-07 10:04:47"
                }
            },
            "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"
                }
            }
        }
    ]
}

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 related to 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.
PushPlatform
Integer
Push vendor (online push EventType = 2 is case-insensitive, by default returns 0). Value ranges from 0 to 8.
0: unknown vendor
1:Apple APNS
2: Xiaomi
3: Huawei
4:Google FCM
5: Meizu
6:OPPO
7:vivo
8: honor
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 is recently activated.
IMCommitStat
Object
Submit the IM server status.
IMStat
Object
IM server status.
OfflinePushStat
Object
State of the offline channel.
OfflineStat
Object
Submit the state of the offline channel.
ChannelStat
Object
Submit the status of the manufacturer channel.
DeviceStat
Object
Message push to device state.
ClickStat
Object
User click state.
OnlinePushStat
Object
State of the online channel.
ChannelStat
Object
Submit the status of the manufacturer channel.
DeviceStat
Object
Message push to device state.
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 (such as 502) occurs, 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.
Common error codes (60000 to 79999), see Error Code.
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 whether the parameters are legal according to the documentation.
90102
Internal error, please try again later.
90103
Failed to switch accounts. Please check if the UserID is valid.


Previous Topic: All/Tagged Users Push Loss AnalysisNext Topic: Chat Service Push Data Statistics

Help and Support

Was this page helpful?

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

Feedback