このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

Obtaining Application Attribute Names

Feature Overview
This API is used by the administrator to obtain application attribute names. To call this API, you need to set application attribute names 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
The request protocol is HTTPS and the request method is POST.
xxxxxx
The dedicated domain name corresponding to the country/region of the 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/get_attr_name
Request API.
usersig
The signature generated by the app admin account. For details, see Generating UserSig.
identifier
The app admin account.
sdkappid
The SDKAppID assigned by the Chat console when an application is created.
random
A random 32-bit unsigned integer.
contenttype
The value is always json.
Maximum Call Frequency
100 times/second
Sample Request Packets
{}
Request Fields
None.
Sample Response Packets
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "AttrNames": {
        "0": "sex",
        "1": "city",
        "2": "level"
    }
}
Response Fields
Field
Type
Description
ActionStatus
String
Processing result. OK: succeeded. FAIL: failed.
ErrorCode
Integer
Error code.
ErrorInfo
String
Error information.
AttrNames
Object
A series of key-value pairs. Each key-value pair indicates the name of the corresponding attribute. For example, "0":"xxx" indicates that the name of attribute 0 is xxx.
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 packets represent the actual error code and error information. For common error codes (60000 to 79999), 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 request packets meet JSON specifications.
90009
The request requires app admin permissions.
90018
The number of requested accounts exceeds the limit.
91000
Internal service error. Try again.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
References
﻿Pushing to All/Tagged Users﻿
﻿Setting Application Attribute Names﻿
﻿Obtaining Application Attribute Names﻿
﻿Setting User Attributes﻿
﻿Deleting User Attributes﻿
﻿Obtaining User Attributes﻿
﻿Obtaining User Tags﻿
﻿Adding User Tags﻿
﻿Deleting User Tags﻿
﻿Deleting All User Tags﻿
﻿Recalling Push﻿
﻿

Feature Overview
Error Codes
API Debugging Tool
References

Parameter	Description
https	The request protocol is HTTPS and the request method is POST.
xxxxxx	The dedicated domain name corresponding to the country/region of the 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/get_attr_name	Request API.
usersig	The signature generated by the app admin account. For details, see Generating UserSig.
identifier	The app admin account.
sdkappid	The SDKAppID assigned by the Chat console when an application is created.
random	A random 32-bit unsigned integer.
contenttype	The value is always `json`.

Field	Type	Description
ActionStatus	String	Processing result. `OK`: succeeded. `FAIL`: failed.
ErrorCode	Integer	Error code.
ErrorInfo	String	Error information.
AttrNames	Object	A series of key-value pairs. Each key-value pair indicates the name of the corresponding attribute. For example, "0":"xxx" indicates that the name of attribute 0 is xxx.

Error Code	Description
90001	Failed to parse the JSON format. Check whether the request packets meet JSON specifications.
90009	The request requires app admin permissions.
90018	The number of requested accounts exceeds the limit.
91000	Internal service error. Try again.