- Release Notes
- Product Introduction
- Purchase Guide
- Download
- Get Started
- Quick Integration Solution (Including UI Library) (Recommended)
- Self-implementing Integration Solution
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Recent Contacts
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Deleting Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Getting Custom Group Attributes
- Modifying Custom Group Attributes
- Clearing Custom Group Attributes
- Resetting Custom Group Attributes
- Global Mute Management
- Operations Management
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callbacks After Recalling Group Messages
- Callback Mutual Authentication Configuration Guide
- Use Cases
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
- Release Notes
- Product Introduction
- Purchase Guide
- Download
- Get Started
- Quick Integration Solution (Including UI Library) (Recommended)
- Self-implementing Integration Solution
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Recent Contacts
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Deleting Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Getting Custom Group Attributes
- Modifying Custom Group Attributes
- Clearing Custom Group Attributes
- Resetting Custom Group Attributes
- Global Mute Management
- Operations Management
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callbacks After Recalling Group Messages
- Callback Mutual Authentication Configuration Guide
- Use Cases
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
Feature Description
This API is used to obtain user attributes. To call this API, you must use the admin account. You can obtain a maximum of 100 users’ attributes at a time.You need to set the App attribute name before calling the API.
API Call Description
The feature is available only to users with Flagship edition accounts. See Configuration Change Ticket to apply for this feature. The feature will be enabled 48 hours after your application is approved.
Sample request URL
https://xxxxxx/v4/all_member_push/im_get_attr?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 | The country/region where your SDKAppID is located.console.tim.qq.com adminapisgp.im.qcloud.com adminapikr.im.qcloud.comadminapiger.im.qcloud.comadminapiind.im.qcloud.com |
| v4/all_member_push/im_get_attr | Request API |
| usersig | Signature generated by the app admin account. For more information, see the UserSig backend API. |
| identifier | The value must be the app admin account. |
| sdkappid | SDKAppID assigned by the IM console when the app is created |
| random | A random 32-bit unsigned integer |
| contenttype | Fixed value: JSON |
Maximum call frequency
The maximum call frequency is 100 times per second.
Sample request packet
{
"To_Account": [
"Zhang Xiaohong",
"Chen Xiaoming",
"abc"
]
}
Request packet fields
| Field | Type | Attribute | Description |
|---|---|---|---|
| To_Account | Array | Required | List of target user accounts |
Sample response packet
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"UserAttrs": [
{
"To_Account": "Zhang Xiaohong",
"Attrs": {
"sex": "Female",
"city": "New York"
}
},
{
"To_Account": "abc",
"Attrs": {}
},
{
"To_Account": "Chen Xiaoming",
"Attrs": {
"sex": "Male",
"city": "Shenzhen"
}
}
]
}
Response packet fields
| Field | Type | Description |
|---|---|---|
| ActionStatus | String | Processing result of the request. Valid values: OK for succeeded, and FAIL for failed |
| ErrorCode | Integer | Error code |
| ErrorInfo | String | Error information |
| UserAttrs | Array | List of user tag content |
| To_Account | String | User account |
| Attrs | Object | Attribute content |
Error Codes
The HTTP return code for this API is always 200 unless a network error (such as error 502) occurs. The actual error code and error message are indicated by ErrorCode and ErrorInfo in the response packet, respectively. For public error codes 60000 to 79999, see Error Codes.
The error codes specific to this API are as follows:
| Error Code | Description |
|---|---|
| 90001 | Failed to parse the JSON format. To correct it, check whether the JSON request packet meets JSON specifications. |
| 90018 | The number of accounts requested exceeds the limit. |
| 91000 | An internal service error occurred. To correct it, try again. |
API Debugging Tool
To debug this API, you can use the online debugging tool for RESTful APIs.
Yes
No
Was this page helpful?