tencent cloud

Chat

News and Announcements
Release Notes
Announcements
Product Introduction
Overview
Basic Concepts
Scenarios
Features
Account System
User Profile and Relationship Chain
Message Management
Group Related
Official Account
Audio/Video Call
Use Limits
Purchase Guide
Billing Overview
Pricing
Purchase Instructions
Renewal Guide
Service Suspension Explanation
Refund Policy
Development Guidelines
Demo Zone
Activate Service
Free Demos
Quick Run
Download
SDK and Demo Source Code
Update Log
Chat Interaction (UI Included)
TUIKit Introduction
Getting Started
Full-feature Integration
Single-function Integration
Build with AI
Build Basic Interfaces
More Features
Customizing Appearance
Internationalization
Push Service
Overview
Noun explanation
Activate the Service
Quick Start
Manufacturer Channel
Statistics
Troubleshooting Tool
Client APIs
REST API
Push Callback
Advanced Features
Release Notes
Error Codes
FAQS
Desk
Overview
Quick Start
Integration Guide
Admin Operation Manual
Agent Manual
More Practices
Live Streaming Setup Guide
AI Chatbot
Super Large Entertainment and Collaboration Community
Discord Implementation Guide
How to Integrate Chat into Games
WhatsApp Channel-style Official Account Integration Solution
Send Red Packet
Firewall Restrictions
No UI Integration
Quick Start
SDK Integration
Initialization
Login and Logout
Message
Conversation
Group
Community Topic
User Profile and Relationship Chain
Offline Push
Cloud Search
Local Search
Official Channel Management
Client APIs
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
Server APIs
Secure authentication with UserSig
RESTful APIs
Webhooks
Console Guide
New Console Introduction
Creating and Upgrading an Application
Basic Configuration
Feature Configuration
Account Management
Group Management
Official Channel Management
Webhook Configuration
Usage
Viewing Guide for Resource Packages
Real-Time Monitor
Auxiliary Development Tools
Access Management
Advanced Features
FAQs
uni-app FAQs
Purchase
SDK
Account Authentication
User Profile and Relationship Chain
Message
Group
Audio-Video Group
Nickname and Profile Photo
Security Compliance Certification
Service Level Agreement
Security Compliance Certification
Chat Policies
Privacy Policy
Data Privacy and Security Agreement
Migration
Migration Solutions
Migration Solutions Lite
Error Codes
Contact Us
DocumentationChatPush ServiceREST APIObtaining User Attributes

Obtaining User Attributes

PDF
Focus Mode
Font Size
Last updated: 2025-07-17 15:55:40

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
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, support UserID or RegistrationID.

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
Target user account: UserID or RegistrationID.
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
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
Previous Topic: Obtaining Application Attribute NamesNext Topic: Setting User Attributes

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback