Docs Overview/
Chat/
SDK/
JavaScript/
User/
User Profile/

User Profile

Feature Description

Users can set and get their nicknames, profile photos, and statuses as well as the profile information of non-friend users.

User Profile Management

Querying a user's own profile

API
chat.getMyProfile();
Returned value
Promise
Sample
let promise = chat.getMyProfile();
promise.then(function(imResponse) {
  console.log(imResponse.data); // Personal profile - profile instance
}).catch(function(imError) {
  console.warn('getMyProfile error:', imError); // Failed to obtain the user's profile
});

Querying the profile of another user

Note:
1. f you haven't configured a custom profile field or have configured it without a value, this API will not return the custom profile content.
2. Up to 100 users can be pulled at a time, as a large data volume will cause a response failure. If the length of the array passed in exceeds 100, only the first 100 users will be queried, and the rest will be discarded.
API
chat.getUserProfile(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
userIDList
Array
List of user accounts, which is an array.
Returned value
Promise
Sample
let promise = chat.getUserProfile({
   // even if you retrieve the profile of only one user, the value must be of array type
   // for example, userIDList: ['user1']
   userIDList: ['user1', 'user2']
});
promise.then(function(imResponse) {
  console.log(imResponse.data); // Array that stores other users' profiles - [Profile]
}).catch(function(imError) {
  console.warn('getUserProfile error:', imError); // Failed to obtain the user's profile
});

Updating your personal profile

API
chat.updateMyProfile(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
nick
String | undefined
Nickname
avatar
String | undefined
Profile photo URL
gender
String | undefined
Gender. Valid values:
TencentCloudChat.TYPES.GENDER_UNKNOWN (not set)
TencentCloudChat.TYPES.GENDER_FEMALE (female)
TencentCloudChat.TYPES.GENDER_MALE (male)
selfSignature
String | undefined
Status
allowType
String | undefined
When a friend request is received: Valid values:
TencentCloudChat.TYPES.ALLOW_TYPE_ALLOW_ANY (no approval required)
TencentCloudChat.TYPES.ALLOW_TYPE_NEED_CONFIRM (approval required)
TencentCloudChat.TYPES.ALLOW_TYPE_DENY_ANY (reject)
birthday
Number | undefined
Birth date, such as 20000101.
location
String | undefined
Location. We recommend you define a mapping relationship between numbers and locations locally. Actually, the backend saves four numbers of the uint32_t type. Here, the first uint32_t indicates the country, the second the province, the third the city, and the fourth the district/county.
language
Number | undefined
Language
messageSettings
Number | undefined
Message settings. Valid values:
0 (receive messages)
1 (don't receive messages)
adminForbidType
String | undefined
Friending. Valid values:
TencentCloudChat.TYPES.FORBID_TYPE_NONE (allow, which is the default value)
TencentCloudChat.TYPES.FORBID_TYPE_SEND_OUT (disallow)
level
Number | undefined
Level. We recommend you split it to save the level information of multiple roles.
role
Number | undefined
Role. We recommend you split it to save the information of multiple roles.
profileCustomField
Array | undefined
Collection of custom profile key-value pairs, which can be used as needed.
Returned value
Promise
Sample
// Modify a user's profile
let promise = chat.updateMyProfile({
  nick: 'My nickname',
  avatar: 'http(s)://url/to/image.jpg',
  gender: TencentCloudChat.TYPES.GENDER_MALE,
  selfSignature: 'My status',
  allowType: TencentCloudChat.TYPES.ALLOW_TYPE_ALLOW_ANY
});
promise.then(function(imResponse) {
  console.log(imResponse.data); // Profile updated successfully
}).catch(function(imError) {
  console.warn('updateMyProfile error:', imError); // Failed to update the profile
});
// Modify personal custom profile fields
// Custom profile fields must be configured in the Chat console in advance 
// by clicking the desired app card and choosing Feature Configuration > User Custom Field
let promise = chat.updateMyProfile({
  profileCustomField: [
    {
      key: 'Tag_Profile_Custom_Test1',
      value: 'My custom profile 1'
    }
  ]
});
promise.then(function(imResponse) {
  console.log(imResponse.data); // Profile updated successfully
}).catch(function(imError) {
  console.warn('updateMyProfile error:', imError); // Failed to update the profile
});
// Modify personal standard and custom profile fields
// Custom profile fields must be configured in the Chat console in advance
// by clicking the desired app card and selecting Feature Configuration > User Custom Field.
let promise = chat.updateMyProfile({
  nick: 'My nickname',
  profileCustomField: [
    {
      key: 'Tag_Profile_Custom_Test1',
      value: 'My custom profile 1'
    },
    {
      key: 'Tag_Profile_Custom_Test2',
      value: 'My custom profile 2'
    },
  ]
});
promise.then(function(imResponse) {
  console.log(imResponse.data); // Profile updated successfully
}).catch(function(imError) {
  console.warn('updateMyProfile error:', imError); // Failed to update the profile
});