Obtaining User Tags
Feature Overview
Retrieve User Tags (must be called with an admin account). You can only retrieve tags for a maximum of 100 users at a time.
Sample request URL
https://xxxxxx/v4/timpush/get_tag?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json
Request parameters
Parameter | Description |
https | The request protocol is: HTTPS Request method: POST |
xxxxxx | The dedicated domain corresponding to the country/region of your SDKAppID. China: console.tim.qq.comSingapore : adminapisgp.im.qcloud.comSeoul : adminapikr.im.qcloud.comFrankfurt : adminapiger.im.qcloud.comSilicon Valley : adminapiusa.im.qcloud.com |
v4/timpush/get_tag | Request API |
usersig | |
identifier | |
sdkappid | SdkAppid assigned by the Instant Messaging Console when an application is created |
random | 32-bit unsigned integer random number |
contenttype | Fixed value: json |
Call frequency limit
100 times per second.
Sample request packets
{"To_Account": ["xiaoming","xiaohong"]}
Request packet fields
Field | Type | Attribute | Description |
To_Account | Array | Required | Target User Account List |
Sample response packets
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"UserTags": [{"To_Account": "xiaoming","Tags": ["GoldMember", "WeekPassUser"]},{"To_Account": "xiaohong","Tags": ["PlatinumMember", "MonthPassUser"]}]}
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 |
UserTags | Array | User Tag Content List |
To_Account | String | User Account |
Tags | Array | Tag array: Each Tag must be a string type and the maximum length of a single Tag should not exceed 50 bytes |
Error codes
Unless a network error occurs (e.g., 502 error), the HTTP return code of this interface is always 200.The actual error code and error message are indicated by ErrorCode and ErrorInfo in the response payload.. For public error codes (60000 to 79999), refer to the Error Codes documentation.
The 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. |
90018 | The number of requested accounts exceeds the limit. |
91000 | Internal service error, please try again. |
API Debugging Tool
Reference
