Pushing to All/Tagged Users

All-user/Tag Push supports sending specific content and can also send personalized content to specific user groups based on Tags and attributes, for example, membership activities, regional notifications, etc. This helps in user acquisition, conversion, activation promotion, and other operational phases, while also supporting push delivery reports and self-service push troubleshooting tools. For specific effects, please refer to Effect Display.
Feature Overview
Support pushing to all users.
Support pushing by user attributes.
Support pushing by user Tags.
Support online channels and vendor channels (APNS, Huawei, Honor, OPPO, vivo, Xiaomi, Meizu, Google).
Due to the large number of accounts that need to be delivered for All-user/Tag Push, it takes a certain amount of time to deliver all accounts (depending on the total number of accounts).
Note:
This API supports both online and offline push. Online push is supported only in SDK Version >= 8.2.6325.
API Calling Description
Sample request URL
https://xxxxxx/v4/timpush/push?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json
Request parameters
Parameter
Description
https
Request protocol: HTTPS
Request method: POST
xxxxxx
The country/region where your SDKAppID is located.
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
v4/timpush/push
Request API
usersig
The signature generated by the App Administrator Account. For details on the procedure, see Generate UserSig﻿
identifier
Must be an App Administrator Account. For more details, see App Administrator﻿
sdkappid
SdkAppid assigned by the Chat console when an app is created
random
32-bit unsigned integer random number
contenttype
Fixed value: json
Call frequency limit
This API includes all-user, attribute, and Tag Push. By default, it can be invoked up to 100 times per day, with an interval of more than 1 second between each push.
Note:
API Frequency Limit. By default, you can make 100 free calls per day. Each additional call will cost an extra $10 per day. If you need to adjust the API frequency, please go to the Chat Console.
Sample request packets
Note:
This API supports both online and offline push. Online push is supported only in SDK Version >= 8.2.6325.
All-user Push Examples
The administrator pushes to all users:
{
  "From_Account": "administrator",
  "MsgRandom": 3674128,
  "OfflinePushInfo": {
      "PushFlag": 0,  // 0 means offline push enabled, 1 means offline push disabled
      "Title": "Offline Push Title",
      "Desc": "Offline Push Content"
  }
}
 Push only to online users (Online Push):
{
  "From_Account": "administrator",
  "MsgRandom": 3674128,
  "OfflinePushInfo": {
      "PushFlag": 1,  // 0 means offline push enabled, 1 means offline push disabled
      "Ext": "Transparent content"
  }
}
Push by User Tag Examples
The administrator pushes to users tagged with "Stock A" and "Stock B":
{
  "From_Account": "administrator",
  "MsgRandom": 124032,
  "Condition": {
      "TagsAnd": ["Stock A","Stock B"]
  },
  "OfflinePushInfo": {
      "PushFlag": 0, // 0 means offline push enabled, 1 means offline push disabled
      "Title": "Offline Push Title",
      "Desc": "Offline Push Content"
  }
}
The administrator pushes to users tagged with "Stock A" or "Stock B":
{
  "From_Account": "administrator",
  "MsgRandom": 124032,
  "Condition": {
      "TagsOr": ["Stock A","Stock B"]
  },
  "OfflinePushInfo": {
      "PushFlag": 0, // 0 means offline push enabled, 1 means offline push disabled
      "Title": "Offline Push Title",
      "Desc": "Offline Push Content"
  }
}
Push by User Attribute
The administrator pushes messages to ultra-platinum members in Shenzhen:
{
  "From_Account": "administrator",
  "MsgRandom": 389475,
  "Condition": {
      "AttrsAnd": {
          "Membership Level": "Ultra-Platinum Member",
          "city": " Shenzhen "
      }
  },
  "OfflinePushInfo": {
      "PushFlag": 0, // 0 means offline push enabled, 1 means offline push disabled
      "Title": "Offline Push Title",
      "Desc": "Offline Push Content"
  }
}
The administrator pushes messages to ultra-platinum users in Shenzhen:
{
  "From_Account": "administrator",
  "MsgRandom": 389475,
  "Condition": {
      "AttrsAnd": {
          "Membership Level": "Ultra-Platinum User",
          "city": " Shenzhen "
      }
  },
  "OfflinePushInfo": {
      "PushFlag": 0, // 0 means offline push enabled, 1 means offline push disabled
      "Title": "Offline Push Title",
      "Desc": "Offline Push Content"
  }
}
Request packet fields
Field
Type
Attribute
Description
From_Account
String
Optional
Message Sender Account (supports specifying any existing account)
If the sender is not specified or the specified sender does not exist, the default will be the caller's account.
MsgRandom
Integer
Required
Message Random Number (32-bit unsigned integer), used by the backend for deduplication of messages within the same second. Please ensure that this field is filled with random values
Condition
Object
Optional
Condition has four types:
AttrsOr means attribute's "Or Condition"
AttrsAnd means attribute's "And Condition"
TagsOr means Tag's "Or Condition" 
TagsAnd means Tag's "And Condition"
AttrsOr, AttrsAnd, TagsOr, TagsAnd cannot coexist. If there is no Condition, it will be pushed to all users.
TagsOr
Array
Optional
Union of Tag conditions. Tag is a string of no more than 50 bytes.
Attribute push and Tag push cannot simultaneously be push conditions. The number of Tags in the TagsOr condition does not exceed 10.
TagsAnd
Array
Optional
Intersection of Tag conditions. Tag is a string of no more than 50 bytes.
Attribute push and Tag push cannot simultaneously be push conditions. The number of Tags in the TagsAnd condition does not exceed 10.
AttrsOr
Object
Optional
Union of attribute conditions.
Attribute push and Tag push cannot simultaneously be push conditions.
AttrsAnd
Object
Optional
Intersection of attribute conditions.
Attribute push and Tag push cannot simultaneously be push conditions.
OfflinePushInfo
Object
Optional
Offline push notification configuration, please refer to OfflinePushInfo description﻿
Sample response packets
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "TaskId": "53743040_144115212910570789_4155518400_15723514"
}
Response packet fields description
Field
Type
Description
ActionStatus
String
Result of request processing:
OK: Indicates successful processing
FAIL: Indicates failure
ErrorCode
Integer
Error code
ErrorInfo
String
Error message
TaskId
String
Push task ID
Error codes
Unless a network error occurs (e.g., 502 error), the HTTP return code for this interface is always 200. The actual error codes and error messages are indicated by ErrorCode and ErrorInfo in the response body. Common error codes (60000 to 79999) can be found in the Error Codes documentation.
The private error codes for this API are as follows:
Error code
Description of Meaning
90001
Failed to parse the JSON string, please check if the request packet conforms to JSON format.
90005
The MsgRandom field is missing in the JSON format request body or the MsgRandom field is not of Integer type.
90009
The request requires App Administrator access.
90020
Tag length exceeds the limit (cannot exceed 50 bytes).
90022
Duplicate Tag in TagsOr and TagsAnd in push conditions.
90024
Excessive Frequency of Push, the interval between two pushes must be greater than 1 second.
90026
Message offline storage time error (must not exceed 7 days).
90032
The number of tags in push conditions exceeds 10, or the number of tags in the add tag request exceeds 10.
90033
Invalid attribute.
90039
Attribute push and Tag push cannot coexist.
90040
One of the tags in the push conditions is empty.
90045
The all-staff/Tag push feature is not activated.
90047
The number of pushes has exceeded the daily limit (default is 100 times).
90056
The request body for universal push notification is too large. Currently, a maximum length of 10K is supported.
91000
Internal service error. Please try again.
API Debugging Tool
Use the  REST API online testing  tool to debug this API.
Reference
﻿All-user/Tag Push﻿
﻿Single push with userID﻿
﻿Obtaining Application Attribute Names﻿
﻿Setting Application Attribute Names﻿
﻿Getting User Attributes﻿
﻿Setting User Attributes﻿
﻿Deleting User Attributes﻿
﻿Getting User Tags﻿
﻿Adding User Tags﻿
﻿Deleting User Tags﻿
﻿Clearing User Tags﻿
﻿Recall Push﻿
﻿

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Parameter	Description
https	Request protocol: HTTPS Request method: POST
xxxxxx	The country/region where your SDKAppID is located. 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`
v4/timpush/push	Request API
usersig	The signature generated by the App Administrator Account. For details on the procedure, see Generate UserSig
identifier	Must be an App Administrator Account. For more details, see App Administrator
sdkappid	SdkAppid assigned by the Chat console when an app is created
random	32-bit unsigned integer random number
contenttype	Fixed value: json

Field	Type	Attribute	Description
From_Account	String	Optional	Message Sender Account (supports specifying any existing account) If the sender is not specified or the specified sender does not exist, the default will be the caller's account.
MsgRandom	Integer	Required	Message Random Number (32-bit unsigned integer), used by the backend for deduplication of messages within the same second. Please ensure that this field is filled with random values
Condition	Object	Optional	Condition has four types: AttrsOr means attribute's "Or Condition" AttrsAnd means attribute's "And Condition" TagsOr means Tag's "Or Condition" TagsAnd means Tag's "And Condition" AttrsOr, AttrsAnd, TagsOr, TagsAnd cannot coexist. If there is no Condition, it will be pushed to all users.
TagsOr	Array	Optional	Union of Tag conditions. Tag is a string of no more than 50 bytes. Attribute push and Tag push cannot simultaneously be push conditions. The number of Tags in the TagsOr condition does not exceed 10.
TagsAnd	Array	Optional	Intersection of Tag conditions. Tag is a string of no more than 50 bytes. Attribute push and Tag push cannot simultaneously be push conditions. The number of Tags in the TagsAnd condition does not exceed 10.
AttrsOr	Object	Optional	Union of attribute conditions. Attribute push and Tag push cannot simultaneously be push conditions.
AttrsAnd	Object	Optional	Intersection of attribute conditions. Attribute push and Tag push cannot simultaneously be push conditions.
OfflinePushInfo	Object	Optional	Offline push notification configuration, please refer to OfflinePushInfo description

Error code	Description of Meaning
90001	Failed to parse the JSON string, please check if the request packet conforms to JSON format.
90005	The MsgRandom field is missing in the JSON format request body or the MsgRandom field is not of Integer type.
90009	The request requires App Administrator access.
90020	Tag length exceeds the limit (cannot exceed 50 bytes).
90022	Duplicate Tag in TagsOr and TagsAnd in push conditions.
90024	Excessive Frequency of Push, the interval between two pushes must be greater than 1 second.
90026	Message offline storage time error (must not exceed 7 days).
90032	The number of tags in push conditions exceeds 10, or the number of tags in the add tag request exceeds 10.
90033	Invalid attribute.
90039	Attribute push and Tag push cannot coexist.
90040	One of the tags in the push conditions is empty.
90045	The all-staff/Tag push feature is not activated.
90047	The number of pushes has exceeded the daily limit (default is 100 times).
90056	The request body for universal push notification is too large. Currently, a maximum length of 10K is supported.
91000	Internal service error. Please try again.

tencent cloud

New User Offers

Next-Generation CDN：EdgeOne

Elasticsearch Service Special Offers

Free Tier

Tencent Cloud Startup Program

Special Offers

Lighthouse Special Offers

Cloud Object Storage Special Offers

Featured Products

New Products

Education

Tencent Cloud Online Education Solutions

Gaming

Gaming Solution

Game Media Solutions

Financial Services

Financial Services Solution

Audio & Video

Audio/Video Solution

LVB Recording Solution

Interactive Classroom Solution

Interactive Live Streaming Solution

Audio Chat Social Networking Solution

Real Estate

Tencent Cloud LinkBase(Weiling)

E-commerce

E-commerce retail solutions

Compute

Cloud Virtual Machine

Auto Scaling

Batch Compute

CVM Dedicated Host

Database

TencentDB for MySQL

TencentDB for Redis®

TencentDB for CTSDB

TDSQL for MySQL

Data Transfer Service

TencentDB for MongoDB

TencentDB for PostgreSQL

TencentDB for SQL Server

TencentDB for TcaplusDB

Video Service

Cloud Streaming Services

Video on Demand

Media Processing Service

Cloud Application Rendering

Cloud Contact Center

Game Multimedia Engine

Chat

Real-time Communication

Tencent Effect SDK

AI and Machine Learning

Image Creation Large Model

Face Fusion

eKYC

Optical Character Recognition

Video Creation Large Model

Industry Applications

Tencent HealthCare Omics Platform

Container and Middleware

TDMQ for CKafka

Serverless Cloud Function

Tencent Kubernetes Engine

Tencent Kubernetes Engine for Serverless

Networking

Cloud Load Balancer

Virtual Private Cloud

Direct Connect

Cloud Connect Network

NAT Gateway

VPN Connection

Bandwidth Package

Anycast Internet Acceleration

Elastic Network Interface

Flow Logs

Global Application Acceleration Platform

Security

Captcha