Setting Application Attribute Names
Feature Overview
Each application can set custom User Attributes, with a maximum of 10. This interface allows you to set the name of each attribute. Once set, they can be used for push notifications by User Attributes, etc.
Sample request URL
https://xxxxxx/v4/timpush/set_attr_name?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json
Request parameters
Parameter | Description |
https | Request protocol: HTTPS Request method: 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 Frankfurt : adminapiger.im.qcloud.com Silicon Valley : adminapiusa.im.qcloud.com |
v4/timpush/set_attr_name | 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
Setting the 0th attribute of the application means gender, the 1st attribute means city, the 2nd attribute means country.
{"AttrNames": {"0": "sex","1": "city","2": "country"}}
Request packet fields
Field | Type | Attribute | Description |
Number key | String | Required | Indicates which attribute (between "0" and "9") |
Attribute name | String | Required | The attribute name must not exceed 50 bytes. The application can have up to 10 push attributes (numbered from 0 to 9), with the user defining the meaning of each attribute |
Sample response packets
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
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 |
Error codes
Unless a network error occurs (such as a 502 error), the HTTP return code for this interface is always 200.The actual error code and error information are represented by ErrorCode and ErrorInfo in the response body. Common error codes (60000 to 79999) are detailed in the Error codes documentation.
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. |
91000 | Internal service error, please try again. |
API Debugging Tool
Reference