Setting User Attributes
Feature Overview
This API is used by the administrator to set attributes for users. Up to 100 users' attributes can be set at a time. To call this API, you need to set application attribute names first.
Sample Request URL
https://xxxxxx/v4/timpush/set_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 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/set_attr | Request API. |
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
{"UserAttrs":[{"To_Account": "xiaojun012","Attrs": {"sex": "attr1","city": "attr2"}},{"To_Account": "xiaojun013","Attrs": {"city": "attr3","sex": "attr4"}}]}
Request Fields
Field | Type | Required | Description |
To_Account | String | Yes | Target user account. |
Attrs | Object | Yes | Attribute set. Each attribute is a key-value pair, with the key being the attribute name and the value being the user's corresponding attribute value. A user attribute value cannot exceed 50 bytes. |
Sample Response Packets
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
Response Fields
Field | Type | Description |
ActionStatus | String | Processing result. OK : succeeded. FAIL : failed. |
ErrorCode | Integer | Error code. |
ErrorInfo | String | Error information. |
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. |
90033 | Invalid attribute. |
91000 | Internal service error. Try again. |
API Debugging Tool
References