tencent cloud

Obtaining Application Attribute Names
Download PDF
Last updated: 2025-10-23 15:30:54
Obtaining Application Attribute Names
Last updated: 2025-10-23 15:30:54
Download PDF

Feature Overview

Administrator obtaining application attribute name. Please Set Application Attribute Name first.

Sample request URL

https://xxxxxx/v4/timpush/get_attr_name?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json

Request parameters

Parameter
Description
https
Request protocol is HTTPS
Request method is 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
Tokyo：adminapijpn.im.qcloud.com
Frankfurt :adminapiger.im.qcloud.com
Silicon Valley :adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/timpush/get_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 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

{}

Request packet fields

No.

Sample response packets

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "AttrNames": {
        "0": "sex",
        "1": "city",
        "2": "country"
    },
    "AttrTypes": {
        "0": 0, 
        "1": 0,
        "2": 1 // Number key 2 corresponds to the attribute "country", which can only be set by account type 1 (the RegistrationID is automatically generated when the push service registration is succ
    }
}

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.
AttrNames
Object
Contains multiple key-value pairs. Each pair represents the name corresponding to a specific attribute. For example, "0":"xxx" indicates that the name of attribute 0 is xxx
AttrTypes
Object
Containing multiple key-value pairs. Each key-value pair indicates the account type corresponding to the nth attribute.
"0": 0 means the account type of attribute No. 0 is 0 (IM account type).
"0": 1 means the account type of attribute No. 0 is 1 (RegistrationID automatically generated when the push service registration is successful).

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

Use the RESTful API Online Test tool to debug this interface.

Reference

All-user/Tag Push
Set application attribute name
Get application attribute name
Set user attributes
Delete user attributes
Get User Attributes
Add User Tags
Get User Tags
Delete User Tags
Clear User Tags
Push Recall


Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback