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 APISetting Application Attribute Names

Setting Application Attribute Names

PDF
Focus Mode
Font Size
Last updated: 2026-02-11 15:56:31

Feature Overview

Each application can set custom User Attributes, with a maximum of 10. This interface allows you to set the name of each attribute. Once set, they can be used for push notifications by User Attributes, etc.

Sample request URL

https://xxxxxx/v4/timpush/set_attr_name?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/set_attr_name
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 Chat 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

Setting the 0th attribute of the application means gender, the 1st attribute means city, the 2nd attribute means country.
{
    "AttrNames": {
        "0": "sex",
        "1": "city",
        "2": "country"
    },
    "AttrTypes": {
        "0": 0, // ccount type corresponding to setting attributes, which does not support modification afterward.
        "1": 0,
        "2": 0
    }
}

Request packet fields

AttrNames Object description
Field
Type
Attribute
Description
Number key
String
Required
Indicates which attribute (between "0" and "9")
Attribute name
String
Required
The attribute name must not exceed 50 bytes. The application can have up to 10 push attributes (numbered from 0 to 9), with the user defining the meaning of each attribute
AttrTypes Object description
Field
Type
Attribute
Description
Number key
String
Optional
Indicates which attribute (between "0" and "9"), must be a Number Key included in AttrNames.
Account type
Integer
Optional
The account type corresponding to the attribute defaults to 0. An attribute can only correspond to one account type. For details, see Introduction to Typical Push Scenarios.
0: Account type represents: Users log in to IM account to transmit UserID.
1: The account type represents the RegistrationID automatically generated when the push service registration is successful.

Sample response packets

All successful:
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}
All failed:
{
    "ActionStatus": "FAIL",
    "ErrorInfo": "attrName:city already exists at index:1",
    "ErrorCode": 90033
}

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 (such as a 502 error), the HTTP return code for this interface is always 200.The actual error code and error information are represented by ErrorCode and ErrorInfo in the response body. Common error codes (60000 to 79999) are detailed in the Error codes documentation.
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.
91000
Internal service error, please try again.
90033
Invalid attribute settings: duplicate AttrNames not allowed, account type in AttrTypes cannot be modified.

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: UserID-Targeted PushNext Topic: Obtaining Application Attribute Names

Help and Support

Was this page helpful?

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

Feedback