tencent cloud

Adding User Tags
Download PDF
Last updated: 2025-10-23 15:30:54
Adding User Tags
Last updated: 2025-10-23 15:30:54
Download PDF

Feature Overview

Administrator adds tags for users.
Note:
Each request can add tags for up to 100 users. A maximum of 10 tags can be added per user in the request body.
A single user can set up to 100 tags. If the number of tags for the user exceeds 100, please delete old tags before adding new ones.
An application can set a maximum of 1,000 tags. This is the deduplicated total for all users' tags.
The maximum length of a single tag is 50 bytes.

Sample request URL

https://xxxxxx/v4/timpush/add_tag?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
Tokyo：adminapijpn.im.qcloud.com
Frankfurt :adminapiger.im.qcloud.com
Silicon Valley :adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/timpush/add_tag
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

100 times per second.

Sample request packets

{
    "UserTags": [
        {
            "To_Account": "xiaoming",
             "Tags": ["GoldMember", "WeekPassUser"]
        },
        {
            "To_Account": "379C2F0D-290D-47AE-94D1-919058C39C77"  // Automatically generated RegistrationID when push service registration is successful
            "Tags": ["PlatinumMember", "MonthPassUser"]
        }
    ]
}
{
    "Replace": 1, // Overwrite ALL tags of the current user
    "UserTags": [
        {
            "To_Account": "xiaoming",
             "Tags": ["GoldMember", "WeekPassUser"]
        },
        {
            "To_Account": "379C2F0D-290D-47AE-94D1-919058C39C77", // Automatically generated RegistrationID when push service registration is successful
            "Tags": ["PlatinumMember", "MonthPassUser"]
        }
    ]
}

Request packet fields

Field
Type
Attribute
Description
Replace
Integer
Optional
0 means add tag on the basis of existing ones, 1 means overwrite ALL tags of the current user. Default value is 0
UserTags
Object Array
Required
Account tag information.
Field description of json Object in the UserTags array
Field
Type
Attribute
Description
To_Account
String
Required
Target User Account.
Tags
Array
Required
String tag array, the maximum length of a single tag should not exceed 50 bytes.
Maximum array length is 10 when Replace=0
Maximum array length is 100 when Replace=1

Sample response packets

All successful:
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}
Partially successful:
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "ErrorList": [
        {
            "ErrorCode": 90035, // A tag can only be applicable to one account type.
            "To_Account": "379C2F0D-290D-47AE-94D1-919058C39C77"
        }
    ]
}

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.
ErrorList
Object Array
Set attributes may result in partial user success and partial failure. Error message list for failed accounts.
Field description of json Object in the ErrorList array
Field
Type
Description
To_Account
String
Target user account.
ErrorCode
Integer
Error code.
ErrorInfo
String
Error description, which may be empty.

Error codes

Unless a network error occurs (e.g., 502 error), the HTTP return code of this interface is always 200.The actual error code and error message are indicated by ErrorCode and ErrorInfo in the response payload.. For public error codes (60000 to 79999), refer to the Error Codes documentation.
The 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.
90018
The number of requested accounts exceeds the limit.
91000
Internal service error, please try again.
90035
A tag can only be applicable to one account type. When registering a push service successfully, RegistrationID is automatically generated for the IM account type. For details, see Introduction to Typical Push Scenarios.

API Debugging Tool

Use the RESTful API Online Test tool to debug this interface.

Reference

All-user/Tag Push
Set application attribute name
Get application attribute name
Set user attributes
Delete user attributes
Get User Attributes
Add User Tags
Get User Tags
Delete User Tags
Clear User Tags
Push Recall
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback