- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started with Demos
- Console Guide
- SDK Documentation
- SDK Download
- Quick Integration (Including UI Library)
- General Integration (No UI Library)
- Update Logs (Web & Mini Programs)
- Update Log (Native)
- Update Log (Unity)
- Legacy API Tutorials
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Recalling Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Global Mute Management
- Operations Management
- Online States
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callback Mutual Authentication Configuration Guide
- Best Practices
- FAQs
- General References
- Error Codes
- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started with Demos
- Console Guide
- SDK Documentation
- SDK Download
- Quick Integration (Including UI Library)
- General Integration (No UI Library)
- Update Logs (Web & Mini Programs)
- Update Log (Native)
- Update Log (Unity)
- Legacy API Tutorials
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Recalling Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Global Mute Management
- Operations Management
- Online States
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callback Mutual Authentication Configuration Guide
- Best Practices
- FAQs
- General References
- Error Codes
Feature Description
This API is used to set standard profile fields and custom profile fields.
API Calling Description
Request URL example
https://xxxxxx/v4/profile/portrait_set?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The following table lists only the parameters to be modified when this API is called. For details on other parameters, see RESTful API Overview.
| Parameter | Description |
|---|---|
| https | The request protocol is HTTPS, and the request method is POST. |
| xxxxxx | The country/region where your SDKAppID is located.console.tim.qq.comadminapisgp.im.qcloud.com |
| v4/profile/portrait_set | Request API |
| sdkappid | SDKAppID assigned by the IM console when an app is created |
| identifier | The value must be the app admin account. For details, see App Admins. |
| usersig | Signature generated by the app admin account. For details, see Generating UserSig. |
| random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
Maximum calling frequency
The maximum calling frequency is 200 times per second.
Request packet example
{
"From_Account":"id",
"ProfileItem":
[
{
"Tag":"Tag_Profile_IM_Nick",
"Value":"MyNickName"
}
]
}
Request packet fields
| Field | Type | Attribute | Description |
|---|---|---|---|
| From_Account | String | Required | UserID of the user whose profile needs to be set |
| ProfileItem | Array | Required | Profile object array of the target user. Each object in the array contains a Tag and a Value. |
| Tag | String | Required | Profile field to be set. Profile fields that can be set include: 1. Standard profile fields. For details, see Standard Profile Fields 2. Custom profile fields. For details, see Custom Profile Fields. |
| Value | uint64_t/string/bytes | Required | Value of the profile field to be set. For details, see Profile Fields. |
Response packet example
{
"ActionStatus":"FAIL",
"ErrorCode":40001,
"ErrorInfo":"Err_Profile_Comm_Decode_Fail",
"ErrorDisplay":""
}
Response packet fields
| Field | Type | Description |
|---|---|---|
| ActionStatus | String | Request processing result. OK: succeeded. FAIL: failed. |
| ErrorCode | Integer | Error code. 0: succeeded. Others: failed. |
| ErrorInfo | String | Detailed error information |
| ErrorDisplay | String | Detailed error information to be displayed on the client |
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 packet represent the actual error code and error information, respectively.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API.
| Error Code | Description |
|---|---|
| 40001 | A request parameter is incorrect. To correct it, check request parameters based on the error description. |
| 40003 | The requested user account does not exist. |
| 40004 | The request requires app admin permissions. |
| 40005 | A profile field contains sensitive words. |
| 40006 | An internal server error occurred. To correct it, try again later. |
| 40008 | You do not have the permission to write profile fields. For details, see Profile Fields. |
| 40009 | The tag of a profile field does not exist. |
| 40601 | The length of the value of a profile field exceeds 500 bytes. |
| 40605 | The value of a standard profile field is incorrect. For details, see Standard Profile Fields. |
| 40610 | The value type of a profile field is incorrect. For details, see Standard Profile Fields. |
API Commissioning Tool
Use the online commissioning tool for RESTful APIs to commission this API.
References
Pulling profiles (v4/profile/portrait_get)
Yes
No
Was this page helpful?