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

Setting User Attributes

Feature Overview
The administrator sets attributes for users. Each time, a maximum of 100 users can be assigned attributes. Before use, please first set the application attribute name.
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
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
Jakarta: adminapiidn.im.qcloud.com
v4/timpush/set_attr
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
{
    "UserAttrs":
    [
        {
            "To_Account": "379C2F0D-290D-47AE-94D1-919058C39C77", // System-generated RegistrationID upon successful push service registration
            "Attrs": {
                "sex": "female",
                "city": "NewYork"
            }
        },
        {
            "To_Account": "xiaoming",
            "Attrs": {
                "sex": "male",
                "city": "ShenZhen"
            }
        }
    ]
}
Request packet fields
Field
Type
Attribute
Description
To_Account
String
Required
Target User Account
Attrs
Object
Required
Attribute Collection. Each attribute is a key-value pair, where the key is the attribute name, and the value is the corresponding attribute value for the user. User attribute values cannot exceed 50 bytes
Sample response packets
All operations are successful:
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}
Partially successful:
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "ErrorList": [
        {
            "ErrorCode": 90035, // A property can only be applicable to one account type
            "To_Account": "379C2F0D-290D-47AE-94D1-919058C39C77"
        }
    ]
}
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
ErrorList
Object Array
Set attributes. Some users may succeed while others may fail. Error message list for failed accounts.
Field description of json Object in the ErrorList array
Field
Type
Description
To_Account
String
Target user account
ErrorCode
Integer
Error code
ErrorInfo
String
Error description, which may be empty.
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.
90033
Attribute is invalid.
91000
Internal service error, please try again.
90035
A property is only applicable to one account type. When registering a push service successfully, RegistrationID is automatically generated for the Chat account type. For details, see Introduction to Typical Push Scenarios.
API Debugging Tool
Use the RESTful API Online Test tool to debug this interface.
Reference
﻿All-user/Tag Push﻿
﻿Single push with userID﻿
﻿Obtaining Application Attribute Names﻿
﻿Setting Application Attribute Names﻿
﻿Getting User Attributes﻿
﻿Setting User Attributes﻿
﻿Deleting User Attributes﻿
﻿Getting User Tags﻿
﻿Adding User Tags﻿
﻿Deleting User Tags﻿
﻿Clearing User Tags﻿
﻿Recall Push﻿
﻿

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.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	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`

Field	Type	Attribute	Description
To_Account	String	Required	Target User Account
Attrs	Object	Required	Attribute Collection. Each attribute is a key-value pair, where the key is the attribute name, and the value is the corresponding attribute value for the user. User attribute values cannot exceed 50 bytes

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.
90033	Attribute is invalid.
91000	Internal service error, please try again.
90035	A property is only applicable to one account type. When registering a push service successfully, RegistrationID is automatically generated for the Chat account type. For details, see Introduction to Typical Push Scenarios.