tencent cloud

Obtaining User Attributes
Download PDF
Last updated: 2025-10-23 15:30:54
Obtaining User Attributes
Last updated: 2025-10-23 15:30:54
Download PDF

Feature Overview

Get User Attributes (must be called with an admin account). You can retrieve up to 100 users' attributes at a time. Before use, please first set the application attribute names and then set the user attributes.

Sample request URL

https://xxxxxx/v4/timpush/get_attr?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
Tokyo：adminapijpn.im.qcloud.com
Frankfurt :adminapiger.im.qcloud.com
Silicon Valley :adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/timpush/get_attr
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": [
        "Mary",
        "xiaoming",
        "xiaohua"
    ]
}

Request packet fields

Field
Type
Attribute
Description
To_Account
Array
Required
Target User Account List

Sample response packets

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "UserAttrs": [
        {
            "To_Account": "xiaoming",
            "Attrs": {
                "sex": "male",
                "city": "ShenZhen"
            }
        },
        {
            "To_Account": "xiaohua",
            "Attrs": {}
        }
    ],
     "ErrorList": [
        {
            "ErrorCode": 70107, // account does not exist
            "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.
UserAttrs
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 UserAttrs array
Field
Type
Description
To_Account
String
User account.
Attrs
Object
Attribute content. Each attribute is a key-value pair, with the key as the attribute name and the value as the attribute value for this user. the user attribute value must not exceed 50 bytes.
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., 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.
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
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