tencent cloud

Obtaining User Tags
Download PDF
Last updated: 2025-07-17 15:55:41
Obtaining User Tags
Last updated: 2025-07-17 15:55:41
Download PDF

Feature Overview

Retrieve User Tags (must be called with an admin account). You can only retrieve tags for a maximum of 100 users at a time.

Sample request URL

https://xxxxxx/v4/timpush/get_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
Jakarta: adminapiidn.im.qcloud.com
v4/timpush/get_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

{
    "To_Account": [
        "xiaoming",
        "xiaohong",
        "Mary"
    ]
}

Request packet fields

Field
Type
Attribute
Description
To_Account
Array
Required
Target user account list, support UserID or RegistrationID.

Sample response packets

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "UserTags": [
        {
            "To_Account": "xiaoming",
            "Tags": ["GoldMember", "WeekPassUser"]
        },
        {
            "To_Account": "xiaohong",
            "Tags": ["PlatinumMember", "MonthPassUser"]
        }
    ],
    "ErrorList": [
        {
            "ErrorCode": 70107,
            "To_Account": "Mary"
        }
    ]
}

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
UserTags
Object Array
User Tag Content List
ErrorList
Object Array
Set attributes. Some users may succeed while others may fail. Error message list for failed accounts.
Field description of json Object in the UserTags array
Field
Type
Description
To_Account
String
Target user account: UserID or RegistrationID.
Tags
Array
Tag array. The maximum length of a single tag should not exceed 50 bytes. Each tag is a string type.
Field description of json Object in the ErrorList array
Field
Type
Description
To_Account
String
Target user account: UserID or RegistrationID.
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.

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

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback