Docs Overview/
Chat/
All_Platform/
Push Service/
REST API/
Adding User Tags/

Adding User Tags

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
Frankfurt :adminapiger.im.qcloud.com
Silicon Valley :adminapiusa.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
32-bit unsigned integer random number
contenttype
Fixed value: json

Call frequency limit

100 times per second.

Sample request packets

{
    "UserTags": [
        {
            "To_Account": "xiaoming",
             "Tags": ["GoldMember", "WeekPassUser"]
        },
        {
            "To_Account": "xiaohong",
            "Tags": ["PlatinumMember", "MonthPassUser"]
        }
    ]
}

Request packet fields

Field
Type
Attribute
Description
To_Account
String
Required
Target User Account
Tags
Array
Required
Tag array: Each Tag must be a string type and the maximum length of a single Tag should not exceed 50 bytes

Sample response packets

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}

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

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.

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