Tencent Cloud

Recent Pages

UserID-Targeted Push

Last updated: 2024-12-30 16:59:16

Feature Overview
Push to the specified recipient account list, which should contain between [1, 500] accounts.
Supports Online Channel, Manufacturer Channel (APNS, Huawei, Honor, OPPO, vivo, Xiaomi, Meizu, Google).
Note:
This interface supports both Online Push and Offline Push. Online Push is supported only in SDK Version ≥ 8.2.6325.
API Calling Description
Sample request URL
https://xxxxxx/v4/timpush/batch?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json
Request parameters
Parameter
Description
https
Request protocol: 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
v4/timpush/batch
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 Chat console when creating an app
random
32-bit unsigned integer random number
contenttype
Fixed value: json
Call frequency limit
30 times/s
Sample request packets
{
  "From_Account": "administrator",
  "To_Account": ["user1","user2"], // Array size range between [1,500]
  "MsgRandom": 3674128,
  "OfflinePushInfo": {
      "PushFlag": 0,  // 0 means offline push enabled, 1 means offline push disabled
      "Title": "Offline Push Title",
      "Desc": "Offline Push Content"
  }
}
Note:
This interface supports both Online Push and Offline Push. Online Push is supported only in SDK Version ≥ 8.2.6325.
Request packet fields
Field
Type
Attribute
Description
From_Account
String
Required
Message Sender Account (supports specifying any existing account)
To_Account
Array
Required
Message recipient user `UserID`
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
OfflinePushInfo
Object
Required
Offline push notification configuration, please refer to OfflinePushInfo description﻿
Sample response packets
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "TaskId": "batch_667015d4_537529d8_2000005e80aa873_d03ac87_56f5e750"
}
Response packet field description
Field
Type
Description
ActionStatus
String
Processed Request Result:
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., a 502 error), the HTTP status code for this interface will always be 200.The real error codes and messages are indicated in the response body by ErrorCode and ErrorInfo. For common error codes (60000 to 79999), see the Error Code document.
Private error codes for this API are as follows:
Error code
Description
90001
Failed to parse the JSON format. Please ensure the request packet conforms to the JSON specification.
90009
The request requires App Administrator permissions.
90045
All-user/Tags/Single Push is Not Enabled.
91000
Internal service error, please try again.
API Debugging Tool
Use the RESTful API Online Test tool to debug this interface.
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﻿
﻿
﻿

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Recent Pages

UserID-Targeted Push

API Calling Description

Sample request URL

Request parameters

Call frequency limit

Sample request packets

Request packet fields

Sample response packets

Response packet field description

Error codes

API Debugging Tool

Reference

Was this page helpful?

Was this page helpful?

Parameter	Description
https	Request protocol: 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`
v4/timpush/batch	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 Chat console when creating an app
random	32-bit unsigned integer random number
contenttype	Fixed value: json

Field	Type	Attribute	Description
From_Account	String	Required	Message Sender Account (supports specifying any existing account)
To_Account	Array	Required	Message recipient user `UserID`
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
OfflinePushInfo	Object	Required	Offline push notification configuration, please refer to OfflinePushInfo description

Error code	Description
90001	Failed to parse the JSON format. Please ensure the request packet conforms to the JSON specification.
90009	The request requires App Administrator permissions.
90045	All-user/Tags/Single Push is Not Enabled.
91000	Internal service error, please try again.

tencent cloud

Sign Up

Log in

Recent Pages

UserID-Targeted Push

API Calling Description

Sample request URL

Request parameters

Call frequency limit

Sample request packets

Request packet fields

Sample response packets

Response packet field description

Error codes

API Debugging Tool

Reference

Was this page helpful?

Was this page helpful?