- News and Announcements
- Product Introduction
- Purchase Guide
- Free Demos
- Download
- Get Started
- Integration Solution (UI Included) (Recommended)
- Integration Solution (No UI)
- SDK Integration
- Initialization
- Login and Logout
- Message
- Message Overview
- Sending Message
- Receiving Message
- Historical Message
- Forwarding Message
- Modifying Message
- Message Inserting
- Deleting Message
- Clearing Messages
- Recalling Message
- Online Message
- Read Receipt
- Querying Message
- Group @ Message
- Targeted Group Message
- Notification Muting
- Message Extension
- Message Translation
- Conversation
- Group
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- User Management
- Global Mute Management
- Operations Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- Before a Group Is Created
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- Before Group Message Is Sent
- After a Group Message Is Sent
- After a Group Is Full
- After a Group Is Disbanded
- After Group Profile Is Modified
- Callback After Recalling Group Messages
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Webhook Mutual Authentication Configuration Guide
- Use Cases
- End-to-end encrypted chat with Virgil
- Super Large Entertainment and Collaboration Community
- Live Room Setup Guide
- Web-Based Interactive Live Streaming
- Muting/Unmuting Group Members
- How to integrate Tencent IM with Salesforce
- How to integrate Tencent IM with Zendesk
- How to integrate chat widget to your Shopify online store
- How to Integrate Chat into Games
- Flutter Avchatroom
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
- News and Announcements
- Product Introduction
- Purchase Guide
- Free Demos
- Download
- Get Started
- Integration Solution (UI Included) (Recommended)
- Integration Solution (No UI)
- SDK Integration
- Initialization
- Login and Logout
- Message
- Message Overview
- Sending Message
- Receiving Message
- Historical Message
- Forwarding Message
- Modifying Message
- Message Inserting
- Deleting Message
- Clearing Messages
- Recalling Message
- Online Message
- Read Receipt
- Querying Message
- Group @ Message
- Targeted Group Message
- Notification Muting
- Message Extension
- Message Translation
- Conversation
- Group
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- User Management
- Global Mute Management
- Operations Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- Before a Group Is Created
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- Before Group Message Is Sent
- After a Group Message Is Sent
- After a Group Is Full
- After a Group Is Disbanded
- After Group Profile Is Modified
- Callback After Recalling Group Messages
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Webhook Mutual Authentication Configuration Guide
- Use Cases
- End-to-end encrypted chat with Virgil
- Super Large Entertainment and Collaboration Community
- Live Room Setup Guide
- Web-Based Interactive Live Streaming
- Muting/Unmuting Group Members
- How to integrate Tencent IM with Salesforce
- How to integrate Tencent IM with Zendesk
- How to integrate chat widget to your Shopify online store
- How to Integrate Chat into Games
- Flutter Avchatroom
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
Feature Overview
You can set a maximum of 10 custom user attributes for each app. This API is used to set the name of each attribute. After you set attribute names, they can be used for push by user attribute and other purposes.
API Calling Description
Pushing to all users is available only to the Ultimate edition. To use it, you need to purchase the Ultimate edition, go to the console, choose Feature Configuration > Login and Message > Push to all users, and enable the feature.
Sample request URL
https://xxxxxx/v4/all_member_push/im_set_attr_name?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json
Request parameters
| Parameter | Description |
|---|---|
| https | The request protocol is HTTPS and the request method is POST. |
| xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located.console.tim.qq.comadminapisgp.im.qcloud.comadminapikr.im.qcloud.comadminapiger.im.qcloud.comadminapiind.im.qcloud.comadminapiusa.im.qcloud.com |
| v4/all_member_push/im_set_attr_name | Request API |
| usersig | Signature generated in the app admin account. For more information, see Generating UserSig. |
| identifier | The app administration account. |
| sdkappid | SDKAppID assigned by the Chat console when an app is created |
| random | A random 32-bit unsigned integer |
| contenttype | The value is always json. |
Maximum call frequency
100 times/second
Sample request
Set attribute 0 of the app to sex, attribute 1 to city, and attribute 2 to country.
{
"AttrNames": {
"0": "sex",
"1": "city",
"2": "country"
}
}
Request fields
| Field | Type | Required | Description |
|---|---|---|---|
| Digital key | String | Yes | Attribute number (0 to 9). |
| Attribute name | String | Yes | The attribute name cannot exceed the length limit of 50 bytes. An app can have a maximum of 10 push attributes (numbered from 0 to 9), and users can customize the meaning of each attribute. |
Sample response
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}
Response fields
| Field | Type | Description |
|---|---|---|
| ActionStatus | String | Request result. OK: Successful. FAIL: Failed |
| ErrorCode | Integer | Error code |
| ErrorInfo | String | Error information |
Error Codes
Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response represent the actual error code and error information. For public error codes (60000 to 79999), please see Error Codes.
The following table describes the error codes specific to this API:
| Error Code | Description |
|---|---|
| 90001 | Failed to parse the JSON format. Check whether the JSON request meets JSON specifications. |
| 90009 | The request requires app admin permissions. |
| 91000 | Internal service error. Try again. |
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
Yes
No
Was this page helpful?