Tencent Cloud Instant Messaging IM SDK

https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html
Admin
Tencent Cloud Instant Messaging IM SDK provides cross-platform capabilities for integrating...
Tokens:81,797
Snippets:334
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Registering Network Monitor Plugin for React Native (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Example of registering the `@react-native-community/netinfo` plugin for React Native projects. Includes installation instructions and the code to import and register the plugin for network status monitoring.

```javascript
npm install @react-native-community/netinfo --save

import NetInfo from "@react-native-community/netinfo";

chat.registerPlugin({'chat-network-monitor': NetInfo});
```

--------------------------------

### Install Tencent Cloud Chat SDK V2 via npm for upgrade comparison

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-03-integration

This snippet shows the npm command used to install the V2 version of the Tencent Cloud Chat SDK, for comparison with V3 during an upgrade process.

```JavaScript
npm i tim-js-sdk --save
```

--------------------------------

### Install Tencent Cloud Chat SDK via npm

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-06-integration-en

This snippet demonstrates how to install the Tencent Cloud Chat SDK V3 using npm. It is applicable for web, Mini Programs, and uni-app projects, saving the dependency to your project.

```bash
npm install @tencentcloud/chat --save
```

--------------------------------

### Install Tencent Cloud Chat SDK V3 via npm

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-03-integration

This snippet shows how to download the Tencent Cloud Chat SDK V3 for Web, mini-programs, and uni-app platforms using npm.

```JavaScript
npm install @tencentcloud/chat --save
```

--------------------------------

### Registering TIM Upload Plugin for Mini Program (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Example of registering the `tim-upload-plugin` for mini programs. Requires configuring `uploadFile` and `downloadFile` domains in the mini program admin backend to `https://cos.ap-shanghai.myqcloud.com`.

```javascript
// 小程序端使用 tim-upload-plugin，在小程序管理后台增加 uploadFile 域名配置 https://cos.ap-shanghai.myqcloud.com，增加 downloadFile 域名配置 https://cos.ap-shanghai.myqcloud.com
chat.registerPlugin({'tim-upload-plugin': TIMUploadPlugin});
```

--------------------------------

### V3 Chat SDK npm dependency

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-06-integration-en

This snippet provides the npm dependency for the V3 version of the Tencent Cloud Chat SDK. Use this command to install the latest SDK version in your project.

```bash
npm i @tencentcloud/chat --save
```

--------------------------------

### Create Topic-Supported Community in Tencent Cloud Chat SDK (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This example shows how to create a new community group that supports topics using `createGroup`. It specifies the group type as `GRP_COMMUNITY` and enables `isSupportTopic`.

```JavaScript
// Create topic-supported community
let promise = chat.createGroup({
  type: TencentCloudChat.TYPES.GRP_COMMUNITY,
  name: 'WebSDK',
  isSupportTopic: true
});
promise.then(function(imResponse) { // Successfully created
  console.log(imResponse.data.group); // Information of the created group, including groupID and other details
}).catch(function(imError) {
  console.warn('createGroup error:', imError); // Related information for group creation failed
});
```

--------------------------------

### Setting SDK Log Level to Normal (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Example of setting the SDK's log level to `0` (normal level), which outputs more detailed logs, recommended during integration.

```javascript
chat.setLogLevel(0);
```

--------------------------------

### Send File Message (uni-app)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Provides an example for sending file messages within a uni-app environment. It utilizes `uni.chooseFile` to allow the user to select a file, which is then used to create and send the message via `chat.createFileMessage`.

```JavaScript
// uni-app 发送文件
// 1. 选择文件
uni.chooseFile({
  count: 1,
  extension:['.zip','.doc'],
  success: function(res) {
    let message = chat.createFileMessage({
      to: 'user1',
      conversationType: TencentCloudChat.TYPES.CONV_C2C,
      payload: { file: res },
      onProgress: function(event) { console.log('file uploading:', event) }
    });
    // 2. 发送消息
    let promise = chat.sendMessage(message);
    promise.then(function(imResponse) {
      // 发送成功
      console.log(imResponse);
    }).catch(function(imError) {
      // 发送失败
      console.warn('sendMessage error:', imError);
    });
  }
});
```

--------------------------------

### Create Topic-Supported Community Group in TencentCloudChat IM SDK (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This JavaScript example illustrates how to create a `GRP_COMMUNITY` type group that supports topics using the `isSupportTopic` option. It also shows basic success and error handling.

```JavaScript
// 创建支持话题的社群
let promise = chat.createGroup({
  type: TencentCloudChat.TYPES.GRP_COMMUNITY,
  name: 'WebSDK',
  isSupportTopic: true,
});
promise.then(function(imResponse) { // 创建成功
  console.log(imResponse.data.group); // 创建的群的资料
}).catch(function(imError) {
  console.warn('createGroup error:', imError); // 创建群组失败的相关信息
});
```

--------------------------------

### Real-time Signaling APIs

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SimplifiedMessage

APIs for real-time signaling, enabling functionalities like adding/removing listeners, sending/receiving invitations, canceling, accepting, rejecting, getting signaling information, and modifying invitations.

```APIDOC
Signaling:
  addSignalingListener()
  removeSignalingListener()
  invite()
  inviteInGroup()
  cancel()
  accept()
  reject()
  getSignalingInfo()
  modifyInvitation()
```

--------------------------------

### Send File Message (Web - DOM Node Input)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Demonstrates how to create and send a file message in a web environment by passing a DOM node (e.g., from a file input element) to the `createFileMessage` method. The example includes setting message priority, custom data, and tracking upload progress.

```JavaScript
// Web 端发送文件消息示例1 - 传入 DOM 节点
// 1. 创建文件消息实例，接口返回的实例可以上屏
let message = chat.createFileMessage({
  to: 'user1',
  conversationType: TencentCloudChat.TYPES.CONV_C2C,
  // 消息优先级，用于群聊。如果某个群的消息超过了频率限制，后台会优先下发高优先级的消息，详细请参考：https://cloud.tencent.com/document/product/269/3663#.E6.B6.88.E6.81.AF.E4.BC.98.E5.85.88.E7.BA.A7.E4.B8.8E.E9.A2.91.E7.8E.87.E6.8E.A7.E5.88.B6)
  // 支持的枚举值：TencentCloudChat.TYPES.MSG_PRIORITY_HIGH, TencentCloudChat.TYPES.MSG_PRIORITY_NORMAL（默认）, TencentCloudChat.TYPES.MSG_PRIORITY_LOW, TencentCloudChat.TYPES.MSG_PRIORITY_LOWEST
  // priority: TencentCloudChat.TYPES.MSG_PRIORITY_NORMAL,
  payload: {
    file: document.getElementById('filePicker'),
  },
  // 消息自定义数据（云端保存，会发送到对端，程序卸载重装后还能拉取到）
  // cloudCustomData: 'your cloud custom data'
  onProgress: function(event) { console.log('file uploading:', event) }
});

// 2. 发送消息
let promise = chat.sendMessage(message);
promise.then(function(imResponse) {
  // 发送成功
  console.log(imResponse);
}).catch(function(imError) {
  // 发送失败
  console.warn('sendMessage error:', imError);
});
```

--------------------------------

### JavaScript: Add Friend

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This example demonstrates how to add a friend using the `addFriend` method, specifying various options such as the target user, source, remark, group name, and add type. It also shows how to handle different success codes indicating whether confirmation is needed or if the friend was added directly.

```JavaScript
// 添加好友
let promise = chat.addFriend({
  to: 'user1',
  source: 'AddSource_Type_Web',
  remark: '小橙子',
  groupName: '好友',
  wording: '我是 user0',
  type: TencentCloudChat.TYPES.SNS_ADD_TYPE_BOTH
});
promise.then(function(imResponse) {
  // 添加好友的请求发送成功
  const { code } = imResponse.data;
  if (code === 30539) {
    // 30539 说明 user1 设置了【需要经过自己确认对方才能添加自己为好友】，此时 SDK 会触发 TencentCloudChat.EVENT.FRIEND_APPLICATION_LIST_UPDATED 事件
  } else if (code === 0) {
    // 0 说明 user1 设置了【允许任何人添加自己为好友】，此时 SDK 会触发 TencentCloudChat.EVENT.FRIEND_LIST_UPDATED 事件
  }
}).catch(function(imError) {
  console.warn('addFriend error:', imError); // 添加好友失败的相关信息
});
```

--------------------------------

### Get Group Member List (Basic)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Shows a basic usage of `getGroupMemberList` to fetch a general list of group members. The example retrieves 15 members starting from offset 0.

```JavaScript
let promise = chat.getGroupMemberList({ groupID: 'group1', count: 15, offset: 0 });
promise.then(function(imResponse) {
  console.log(imResponse.data.memberList);
}).catch(function(imError) {
  console.warn('getGroupMemberList error:', imError);
});
```

--------------------------------

### Initialize Tencent Cloud Chat SDK Instance

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/TencentCloudChat

Demonstrates how to create an SDK instance for Tencent Cloud Chat, showing both basic initialization with `SDKAppID` and advanced configuration including proxy server settings for WebSocket, file upload, and file download.

```JavaScript
let options = {
  SDKAppID: 0 // 接入时需要将0替换为您的云通信应用的 SDKAppID，类型为 Number
};
let chat = TencentCloudChat.create(options); // SDK 实例通常用 chat 表示
```

```JavaScript
let options = {
  SDKAppID: 0, // 接入时需要将0替换为您的即时通信应用的 SDKAppID
  proxyServer: `ws://${server_ip}:${server_port1}`, // WebSocket 服务器代理地址
  fileUploadProxy: `http://${server_ip}:${server_port2}`, // 图片、视频、文件上传代理地址
  fileDownloadProxy: `http://${server_ip}:${server_port3}` // 图片、视频、文件下载代理地址
};
let chat = TencentCloudChat.create(options); // SDK 实例通常用 chat 表示
```

--------------------------------

### Get Group Member List by Role (Admin)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Demonstrates how to retrieve a list of group members filtered by a specific role, such as administrators, using `getGroupMemberList`. This feature is supported from v3.1.3 onwards. The example fetches 15 members starting from offset 0.

```JavaScript
let promise = chat.getGroupMemberList({ groupID: 'group1', role: TencentCloudChat.TYPES.GRP_MBR_ROLE_ADMIN, count: 15, offset: 0 });
promise.then(function(imResponse) {
  console.log(imResponse.data.memberList);
}).catch(function(imError) {
  console.warn('getGroupMemberList error:', imError);
});
```

--------------------------------

### Get Message Extensions from a Message

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Provides an example of retrieving all extensions associated with a specific message using `getMessageExtensions`.

```JavaScript
let promise = chat.getMessageExtensions(message);
promise.then(function(imResponse) {
  // 获取消息扩展成功
   const { extensions } = imResponse.data;
   extensions.forEach((item) => {
     const { key, value } = item;
     // key - 消息扩展 key
     // value - 消息扩展 key 对应的 value 值
   });
}).catch(function(imError) {
  // 获取消息扩展失败
  console.warn('getMessageExtensions error:', imError);
});
```

--------------------------------

### TencentCloudChat Namespace API Reference

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-02-upgradeguideline

This section documents the 'TencentCloudChat' namespace, which serves as the entry point for interacting with the TencentCloudChat Web SDK. It includes the 'create' method, essential for initializing the SDK instance.

```APIDOC
TencentCloudChat:
  create()
```

--------------------------------

### JavaScript: Get Friend List

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This example demonstrates how to retrieve the current friend list cached by the SDK using the `getFriendList` method. It includes basic success and error handling.

```JavaScript
let promise = chat.getFriendList();
promise.then(function(imResponse) {
  const friendList = imResponse.data; // 好友列表
}).catch(function(imError) {
  console.warn('getFriendList error:', imError); // 获取好友列表失败的相关信息
});
```

--------------------------------

### Get Online Members in Live Group (AVChatRoom)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Demonstrates fetching the online member list for a live group (AVChatRoom) using `getGroupMemberList`. By default, it retrieves up to 500 members starting from offset 0.

```JavaScript
let promise = chat.getGroupMemberList({ groupID: 'group1', offset: 0 });
promise.then(function(imResponse) {
  console.log(imResponse.data.memberList);
}).catch(function(imError) {
  console.warn('getGroupMemberList error:', imError);
});
```

--------------------------------

### TencentCloudChat Namespace and create Method

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-04-comparison

Documents the structure of the TencentCloudChat namespace and its 'create' method, indicating an entry point for SDK initialization or object creation.

```APIDOC
Namespace: TencentCloudChat
  Method: create()
```

--------------------------------

### Get Group Member List with Mute Status

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Illustrates how to retrieve group members and check their mute status using the `muteUntil` timestamp. The example iterates through the member list to determine if a member is currently muted.

```JavaScript
let promise = chat.getGroupMemberList({ groupID: 'group1', count: 15, offset: 0 });
promise.then(function(imResponse) {
  console.log(imResponse.data.memberList);
  for (let groupMember of imResponse.data.memberList) {
    if (groupMember.muteUntil * 1000  > Date.now()) {
      console.log(`${groupMember.userID} 禁言中`);
    } else {
      console.log(`${groupMember.userID} 未被禁言`);
    }
  }
}).catch(function(imError) {
    console.warn('getGroupMemberProfile error:', imError);
});
```

--------------------------------

### Get Specific Group Member Profiles

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Provides an example of using `getGroupMemberProfile` to fetch detailed profiles for specific group members, including custom fields. It highlights that `userIDList` must be an array, even for a single user.

```JavaScript
let promise = chat.getGroupMemberProfile({
  groupID: 'group1',
  userIDList: ['user1', 'user2'],
  memberCustomFieldFilter: ['group_member_custom']
});
promise.then(function(imResponse) {
  console.log(imResponse.data.memberList);
}).catch(function(imError) {
  console.warn('getGroupMemberProfile error:', imError);
});
```

--------------------------------

### Invite Users to Group (Basic)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Demonstrates the basic usage of `chat.inviteInGroup` to invite specified users to a group. It shows how to handle success and error callbacks for the invitation signal.

```JavaScript
// 邀请群内的某些人
let promise = chat.inviteInGroup({
  groupID: 'AV1',
  inviteeList: ['user1', 'user2'],
  data: '',
});
promise.then(function(imResponse) { // 发送邀请信令成功
 console.warn('inviteInGroup success:', imResponse)
}).catch(function(imError) {
  console.warn('inviteInGroup error:', imError);
});
```

--------------------------------

### Get Filtered Online Members in Live Group (AVChatRoom)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Shows how to retrieve online members with a specific custom filter tag in a live group (AVChatRoom) using `getGroupMemberList`. The example fetches members with `filter: 1000`.

```JavaScript
let promise = chat.getGroupMemberList({ groupID: 'group1', filter: 1000, offset: 0 });
promise.then(function(imResponse) {
  console.log(imResponse.data.memberList);
}).catch(function(imError) {
  console.warn('getGroupMemberList error:', imError);
});
```

--------------------------------

### TencentCloudChat Namespace API Reference

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-06-integration-en

Provides an overview of the `TencentCloudChat` namespace and its `create` method.

```APIDOC
Namespace: TencentCloudChat
  Method: create()
```

--------------------------------

### Get C2C Roaming Messages by Time (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This example illustrates fetching older or newer C2C roaming messages using `getMessageListHopping` with a timestamp. It details how to process the response, including the message list, completion status, and next timestamp for continued fetching.

```JavaScript
// 根据时间拉 C2C 会话漫游消息，direction 0 向上拉，拉更旧的消息，direction 1 向下拉，拉更新的消息
let promise = chat.getMessageListHopping({conversationID: 'C2Ctest', time: xxx, count: 15, direction: 0});
promise.then(function(imResponse) {
  const { messageList, isCompleted, nextMessageTime } = imResponse.data;
  // messageList - 消息列表
  // isCompleted - 拉取完成标识，true 已拉完，false 未拉完，可以通过 nextMessageTime 的返回值进行续拉
  // nextMessageTime - 续拉起始时间，当 isCompleted 返回 true 时，nextMessageTime 返回空字符串
});
```

--------------------------------

### Get Group Member List with Filter in Tencent Cloud Chat SDK (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This example shows how to retrieve a list of group members, optionally filtered by a specific mark type. It demonstrates pagination using `offset` and handling the successful retrieval of the member list.

```JavaScript
// Get online member list with specified mark for live group
let promise = chat.getGroupMemberList({ groupID: 'group1', filter: 1000, offset: 0 }); // Pull from 0, by default returns a maximum of 500 group members at a time
promise.then(function(imResponse) {
  console.log(imResponse.data.memberList); // Group member list
}).catch(function(imError) {
  console.warn('getGroupMemberList error:', imError);
});
```

--------------------------------

### Tencent Cloud IM Web SDK Class and Method Reference

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-03-integration

Detailed listing of the `SDK` class and its methods, categorized by functionality such as user authentication, message handling, conversation management, user profiles, and social relationships.

```APIDOC
SDK Class:
  Core Methods:
    login()
    logout()
    getLoginUser()
    getServerTime()
    isReady()
    destroy()
    on()
    off()
    registerPlugin()
    setLogLevel()
  Message Management Methods (消息):
    createTextMessage()
    createTextAtMessage()
    createImageMessage()
    createAudioMessage()
    createVideoMessage()
    createCustomMessage()
    createFaceMessage()
    createFileMessage()
    createLocationMessage()
    createMergerMessage()
    downloadMergerMessage()
    createForwardMessage()
    sendMessage()
    revokeMessage()
    resendMessage()
    deleteMessage()
    translateText()
    convertVoiceToText()
    setMessageExtensions()
    getMessageExtensions()
    deleteMessageExtensions()
    addMessageReaction()
    removeMessageReaction()
    getMessageReactions()
    getAllUserListOfMessageReaction()
  Conversation & Message List Methods (会话):
    modifyMessage()
    getMessageList()
    getMessageListHopping()
    sendMessageReadReceipt()
    getMessageReadReceiptList()
    getGroupMessageReadMemberList()
    findMessage()
    setMessageRead()
    getConversationList()
    getConversationProfile()
    deleteConversation()
    setConversationDraft()
    clearHistoryMessage()
    pinConversation()
    setAllMessageRead()
    setMessageRemindType()
    setAllReceiveMessageOpt()
    getAllReceiveMessageOpt()
    getTotalUnreadMessageCount()
  Conversation Group Management Methods (会话分组):
    setConversationCustomData()
    markConversation()
    getConversationGroupList()
    createConversationGroup()
    deleteConversationGroup()
    renameConversationGroup()
    addConversationsToGroup()
    deleteConversationsFromGroup()
  Search Methods (搜索):
    searchCloudMessages()
    searchCloudUsers()
    searchCloudGroups()
    searchCloudGroupMembers()
  Profile Management Methods (资料):
    getMyProfile()
    getUserProfile()
    updateMyProfile()
    getBlacklist()
    addToBlacklist()
    removeFromBlacklist()
  User Status Methods (用户状态):
    setSelfStatus()
    getUserStatus()
    subscribeUserStatus()
    unsubscribeUserStatus()
  Friendship & Relationship Methods (关系链):
    getFriendList()
    addFriend()
    deleteFriend()
    checkFriend()
    getFriendProfile()
    updateFriend()
    getFriendApplicationList()
    acceptFriendApplication()
    refuseFriendApplication()
```

--------------------------------

### TencentCloudChat API Reference

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-07-breakingchanges-en

Details the TencentCloudChat namespace and its available methods, including the 'create' method.

```APIDOC
Namespaces:
  TencentCloudChat:
    Methods:
      create()
```

--------------------------------

### Get Conversation Group List in Tencent Cloud Chat SDK (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This JavaScript example shows how to retrieve the list of conversation group names using `chat.getConversationGroupList`. It also demonstrates how to then use `chat.getConversationList` to fetch all conversations belonging to a specific group name, such as 'Suppliers'.

```JavaScript
let promise = chat.getConversationGroupList();
promise.then(function(imResponse) {
  const groupNameList = imResponse.data; // 会话分组名列表
});
```

```JavaScript
// 获取指定会话分组下的所有会话
let promise = chat.getConversationList({ groupName: 'Suppliers' });
promise.then(function(imResponse) {
  const conversationList = imResponse.data.conversationList; // 会话列表
});
```

--------------------------------

### Integrate ChatCore for basic chat functionality

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-06-integration-en

This snippet demonstrates integrating only the ChatCore module, which is sufficient for basic functionalities like one-on-one chat and conversations. It shows importing the specific ESM path and initializing the chat instance.

```javascript
import TencentCloudChat from '@tencentcloud/chat/index.es.js';

const chat = TencentCloudChat.create({
  SDKAppID: 0,
});
```

--------------------------------

### Get Group Roaming Messages by Sequence (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This example demonstrates how to use `getMessageListHopping` to retrieve older or newer group roaming messages using a sequence number. It shows how to handle the promise resolution and access message list, completion status, and next sequence for continuation.

```JavaScript
// 根据 sequence 拉群漫游消息，direction 0 向上拉，拉更旧的消息，direction 1 向下拉，拉更新的消息
let promise = chat.getMessageListHopping({conversationID: 'GROUPtest', sequence: xxx, count: 15, direction: 0});
promise.then(function(imResponse) {
  const { messageList, isCompleted, nextMessageSeq } = imResponse.data;
  // messageList - 消息列表
  // isCompleted - 拉取完成标识， true 已拉完，false 未拉完，可以通过 nextMessageSeq 的返回值进行续拉
  // nextMessageSeq - 续拉起始 sequence，当 isCompleted 返回 true 时，nextMessageSeq 返回空字符串
});
```

--------------------------------

### TencentCloudChat API Reference

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-00-quickstart

Defines the TencentCloudChat namespace and its available methods, specifically the 'create' method.

```APIDOC
TencentCloudChat:
  create()
```

--------------------------------

### JavaScript Example: Delete Conversations from Group

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Demonstrates how to use the `deleteConversationsFromGroup` method to remove specified conversations from a group. The example includes handling both successful and failed deletions, iterating through results, and accessing conversation lists.

```JavaScript
let promise = chat.deleteConversationsFromGroup({
  conversationIDList: ['GROUPtest', 'C2Cexample'],
  groupName: 'Suppliers_new'
});
promise.then(function(imResponse) {
  // 从分组删除会话成功
  const { successConversationIDList, failureConversationIDList } = imResponse.data;
  // successConversationIDList - 成功的会话 ID 列表
  // 获取会话列表
  const conversationList = chat.getConversationList(successConversationIDList);

  // failureConversationIDList - 失败的会话 ID 列表
  failureConversationIDList.forEach((item) => {
    const { conversationID, code, message } = item;
  });
}).catch(function(imError) {
  console.warn('deleteConversationsFromGroup error:', imError);
});
```

--------------------------------

### TencentCloudChat Namespace and Methods Reference

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-08-error-code-en

Documents the TencentCloudChat namespace and its 'create' method, providing a hierarchical view of the API structure as presented in the documentation.

```APIDOC
Namespace: TencentCloudChat
  Methods:
    create
```

--------------------------------

### TencentCloudChat API Reference

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/Topic

Overview of the TencentCloudChat JavaScript SDK API, including namespaces and their methods.

```APIDOC
TencentCloudChat:
  create()
```

--------------------------------

### Delete Message Extensions in JavaScript

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Provides JavaScript examples for deleting specific message extension keys or clearing all message extension keys from a message. The examples demonstrate how to handle successful deletion and potential key conflicts (code 23001), prompting for retry based on the latest extension information.

```JavaScript
// 删除消息扩展 key
let promise = chat.deleteMessageExtensions(message, ['a', 'b']);
promise.then(function(imResponse) {
   // 删除消息扩展成功
   const { extensions } = imResponse.data;
   extensions.forEach((item) => {
     const { code, key, value } = item;
     if (code === 23001) {
       // 删除 key 冲突，请根据返回的最新扩展信息，按需进行重试
     }
   });
}).catch(function(imError) {
  // 删除消息扩展失败
  console.warn('deleteMessageExtensions error:', imError);
});
```

```JavaScript
// 清空所有消息扩展 key
let promise = chat.deleteMessageExtensions(message);
promise.then(function(imResponse) {
   // 清空消息扩展成功
   console.log('deleteMessageExtensions ok:', imResponse)
}).catch(function(imError) {
  // 清空消息扩展失败
  console.warn('deleteMessageExtensions error:', imError);
});
```

```APIDOC
deleteMessageExtensions(message, keyList)
Parameters:
  message: [Message] - required. Message instance. The message must meet three conditions: its isSupportExtension property must be true, it must be in a successfully sent state, and it cannot be a live group (AVChatRoom) message.
  keyList: Array - required. List of extension information keys.
Returns:
  Type: [Promise]
```

--------------------------------

### Send File Message (WeChat/QQ Mini Program)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Demonstrates how to send file messages in WeChat or QQ Mini Programs. It uses `wx.chooseMessageFile` or `qq.chooseMessageFile` (with version compatibility notes) to select a file from the client's session, which is then used to create and send the message.

```JavaScript
// 手机端微信小程序或 QQ 小程序法发送文件
// wx.chooseMessageFile 基础库 2.5.0 开始支持，低版本需做兼容处理
// qq.chooseMessageFile 基础库 1.18.0 开始支持，低版本需做兼容处理
// 1. 从客户端会话选择文件
wx.chooseMessageFile({
  count: 1,
  type: 'all', // 从所有文件选择
  success: (res) => {
    const message = chat.createFileMessage({
      to: 'user1',
      conversationType: TencentCloudChat.TYPES.CONV_C2C,
      payload: { file: res },
      onProgress: function(event) { console.log('file uploading:', event) }
    });
    // 2. 发送消息
    let promise = chat.sendMessage(message);
    promise.then(function(imResponse) {
      // 发送成功
      console.log(imResponse);
    }).catch(function(imError) {
      // 发送失败
      console.warn('sendMessage error:', imError);
    });
  }
});
```

--------------------------------

### Retrieve Conversation Lists Filtered by Mark Type in Tencent Cloud Chat SDK (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

These JavaScript examples demonstrate how to fetch conversation lists using `chat.getConversationList` by filtering based on `markType`. The first example retrieves all starred conversations, while the second fetches all folded C2C conversations, showcasing how to combine `markType` with `type` filters.

```JavaScript
// 获取所有标星的会话
let promise = chat.getConversationList({ markType: TencentCloudChat.TYPES.CONV_MARK_TYPE_STAR });
promise.then(function(imResponse) {
  const conversationList = imResponse.data.conversationList; // 会话列表
});
```

```JavaScript
// 获取所有折叠的 C2C 会话
let promise = chat.getConversationList({
  markType: TencentCloudChat.TYPES.CONV_MARK_TYPE_FOLD,
  type: TencentCloudChat.TYPES.CONV_C2C
});
promise.then(function(imResponse) {
  const conversationList = imResponse.data.conversationList; // 会话列表
});
```

--------------------------------

### Set and Clear Conversation Custom Data in Tencent Cloud Chat SDK (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

These JavaScript examples demonstrate how to use `chat.setConversationCustomData` to either set new custom data for C2C and group conversations or clear existing custom data by passing an empty string. Both examples show handling success and failure responses, including retrieving updated conversation lists.

```JavaScript
// 给 C2C 会话和群会话设置会话自定义数据
let promise = chat.setConversationCustomData({
  conversationIDList: ['GROUPtest', 'C2Cexample'],
  customData: 'your custom data'
});
promise.then(function(imResponse) {
  // 设置会话自定义数据成功
  const { successConversationIDList, failureConversationIDList } = imResponse.data;
  // successConversationIDList - 设置成功的会话 ID 列表
  // 获取会话列表
  const conversationList = chat.getConversationList(successConversationIDList);

  // failureConversationIDList - 设置失败的会话 ID 列表
  failureConversationIDList.forEach((item) => {
    const { conversationID, code, message } = item;
  });
}).catch(function(imError) {
  console.warn('setConversationCustomData error:', imError);
});
```

```JavaScript
// customData 传入空字符串，表示清空会话自定义数据
let promise = chat.setConversationCustomData({
  conversationIDList: ['GROUPtest', 'C2Cexample'],
  customData: ''
});
promise.then(function(imResponse) {
  // 清空会话自定义数据成功
  const { successConversationIDList, failureConversationIDList } = imResponse.data;
  // successConversationIDList - 清空成功的会话 ID 列表
  // 获取会话列表
  const conversationList = chat.getConversationList(successConversationIDList);

  // failureConversationIDList - 清空失败的会话 ID 列表
  failureConversationIDList.forEach((item) => {
    const { conversationID, code, message } = item;
  });
}).catch(function(imError) {
  console.warn('setConversationCustomData error:', imError);
});
```

--------------------------------

### Integrate ChatCore with RelationshipModule

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-06-integration-en

This snippet shows how to integrate ChatCore along with the RelationshipModule. This setup is required for projects that need relationship chain functionalities, by including the module in the 'modules' object during initialization.

```javascript
import TencentCloudChat from '@tencentcloud/chat/index.es.js';
import RelationshipModule from '@tencentcloud/chat/modules/relationship-module.js';

const chat = TencentCloudChat.create({
  SDKAppID: 0,
  modules: {
    'relationship-module': RelationshipModule,
  }
});
```

--------------------------------

### TencentCloudChat Namespace and create Method

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/module-EVENT

Documents the structure of the TencentCloudChat API, including its primary namespace and the create method available within it.

```APIDOC
Namespaces:
  TencentCloudChat:
    Methods:
      create()
```

--------------------------------

### V3 Chat SDK standard import statement

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-06-integration-en

This snippet shows the standard JavaScript import statement for the V3 version of the Tencent Cloud Chat SDK. This is the recommended way to import the SDK after installation.

```javascript
import TencentCloudChat from '@tencentcloud/chat';
```

--------------------------------

### TencentCloudChat API Namespace Overview

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/Friend

This snippet outlines the hierarchical structure of the TencentCloudChat Web SDK API, listing the main namespaces and their direct methods as presented in the documentation's table of contents.

```APIDOC
Namespaces:
  TencentCloudChat:
    Methods:
      create()
```

--------------------------------

### Integrate Tencent Cloud Chat SDK V3 UMD (Full Features)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-03-integration

This snippet demonstrates how to integrate the UMD-compliant Tencent Cloud Chat SDK V3, which includes all features, by creating a chat instance with an SDKAppID.

```JavaScript
import TencentCloudChat from '@tencentcloud/chat';

const chat = TencentCloudChat.create({
  SDKAppID: 0,
});
```

--------------------------------

### Tencent Cloud IM Web SDK: SDK Class API

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-04-comparison

Detailed API documentation for the main `SDK` class, including methods for user authentication, message creation and management, conversation handling, user profile updates, and friend relationship management.

```APIDOC
Class: SDK
  Methods:
    // Core
    login()
    logout()
    getLoginUser()
    getServerTime()
    isReady()
    destroy()
    on()
    off()
    registerPlugin()
    setLogLevel()

    // Messaging (消息)
    createTextMessage()
    createTextAtMessage()
    createImageMessage()
    createAudioMessage()
    createVideoMessage()
    createCustomMessage()
    createFaceMessage()
    createFileMessage()
    createLocationMessage()
    createMergerMessage()
    downloadMergerMessage()
    createForwardMessage()
    sendMessage()
    revokeMessage()
    resendMessage()
    deleteMessage()
    translateText()
    convertVoiceToText()
    setMessageExtensions()
    getMessageExtensions()
    deleteMessageExtensions()
    addMessageReaction()
    removeMessageReaction()
    getMessageReactions()
    getAllUserListOfMessageReaction()

    // Conversation (会话)
    modifyMessage()
    getMessageList()
    getMessageListHopping()
    sendMessageReadReceipt()
    getMessageReadReceiptList()
    getGroupMessageReadMemberList()
    findMessage()
    setMessageRead()
    getConversationList()
    getConversationProfile()
    deleteConversation()
    setConversationDraft()
    clearHistoryMessage()
    pinConversation()
    setAllMessageRead()
    setMessageRemindType()
    setAllReceiveMessageOpt()
    getAllReceiveMessageOpt()
    getTotalUnreadMessageCount()

    // Conversation Grouping (会话分组)
    setConversationCustomData()
    markConversation()
    getConversationGroupList()
    createConversationGroup()
    deleteConversationGroup()
    renameConversationGroup()
    addConversationsToGroup()
    deleteConversationsFromGroup()

    // Search (搜索)
    searchCloudMessages()
    searchCloudUsers()
    searchCloudGroups()
    searchCloudGroupMembers()

    // Profile (资料)
    getMyProfile()
    getUserProfile()
    updateMyProfile()
    getBlacklist()
    addToBlacklist()
    removeFromBlacklist()

    // User Status (用户状态)
    setSelfStatus()
    getUserStatus()
    subscribeUserStatus()
    unsubscribeUserStatus()

    // Relationship Chain (关系链)
    getFriendList()
    addFriend()
    deleteFriend()
    checkFriend()
    getFriendProfile()
    updateFriend()
    getFriendApplicationList()
    acceptFriendApplication()
    refuseFriendApplication()
```

--------------------------------

### Integrate full-featured UMD SDK

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-06-integration-en

This snippet illustrates how to integrate the full-featured UMD format of the Tencent Cloud Chat SDK. It shows the creation of a chat instance by calling TencentCloudChat.create and passing the SDKAppID.

```javascript
import TencentCloudChat from '@tencentcloud/chat';

const chat = TencentCloudChat.create({
  SDKAppID: 0,
});
```

--------------------------------

### Create Public Group Requiring Approval in TencentCloudChat IM SDK (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This JavaScript example demonstrates how to create a `GRP_PUBLIC` type group where invitations require approval, by setting the `inviteOption` to `INVITE_OPTIONS_NEED_PERMISSION`.

```JavaScript
// 创建邀请进群需要审批的 TencentCloudChat.TYPES.GRP_PUBLIC 类型群组
let promise = chat.createGroup({
  type: TencentCloudChat.TYPES.GRP_PUBLIC,
  name: 'WebSDK',
  inviteOption: TencentCloudChat.TYPES.INVITE_OPTIONS_NEED_PERMISSION,
});
promise.then(function(imResponse) { // 创建成功
  console.log(imResponse.data.group); // 创建的群的资料
}).catch(function(imError) {
  console.warn('createGroup error:', imError); // 创建群组失败的相关信息
});
```

--------------------------------

### JavaScript: Unsubscribe from All User Statuses

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This example shows how to cancel all current user status subscriptions by calling `unsubscribeUserStatus` without any parameters. It also includes error handling and processing of any failed unsubscriptions.

```JavaScript
// 取消当前所有的订阅
let promise = chat.unsubscribeUserStatus();
promise.then(function(imResponse) {
  const { failureUserList } = imResponse.data;
   // 取消订阅失败的用户列表
   failureUserList.forEach((item) => {
     const { userID, code, message } = item;
     // userID - 查询失败的用户 ID
     // code - 查询失败的错误码
     // message - 查询失败的错误信息
   });
}).catch(function(imError) {
  console.warn('unsubscribeUserStatus error:', imError); // 取消订阅失败的相关信息
});
```

--------------------------------

### API Reference: createTopicInCommunity(options)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Creates a new topic within a community. This functionality requires a specific subscription, console configuration, and prior creation of a topic-supported community.

```APIDOC
createTopicInCommunity(options) → Promise
Description: Creates a new topic.
Note 1: This interface is only for topic-supported communities. Requires purchasing the Ultimate Edition package, enabling community features in the console under [Feature Configuration] > [Group Configuration] > [Group Feature Configuration] > Community, and then enabling topic features.
Note 2: Before calling this interface, you must first call [createGroup](SDK.html#createGroup) to create a topic-supported community.
```

--------------------------------

### Convert Voice to Text using TencentCloudChat SDK

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

Demonstrates how to convert an audio message to text using the `convertVoiceToText` API. It shows examples for common Chinese/English/Cantonese conversion and specific Japanese conversion.

```JavaScript
// 最常用的中英粤语音转文字，language 参数可缺省
let promise = chat.convertVoiceToText({ message: audioMessage });
promise.then(function(imResponse)) {
  // 语音转文字成功
  const { result } = imResponse.data;
}).catch(function(imError) {
  // 语音转文字失败
  console.warn('convertVoiceToText error:', imError);
});
```

```JavaScript
// 日语语音转文字
let promise = chat.convertVoiceToText({ message: audioMessage, language: 'ja-JP'});
promise.then(function(imResponse)) {
  // 语音转文字成功
  const { result } = imResponse.data;
}).catch(function(imError) {
  // 语音转文字失败
  console.warn('convertVoiceToText error:', imError);
});
```

--------------------------------

### Import Tencent Cloud Chat SDK V3

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-03-integration

This snippet demonstrates the standard import statement for the V3 version of the Tencent Cloud Chat SDK.

```JavaScript
import TencentCloudChat from '@tencentcloud/chat';
```

--------------------------------

### TencentCloudChat Web SDK API Index

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/Group

Lists the main namespaces and their top-level methods available in the TencentCloudChat Web SDK, serving as a table of contents for the API documentation.

```APIDOC
Namespaces:
  TencentCloudChat:
    create()
```

--------------------------------

### TencentCloudChat.create() API Reference

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/TencentCloudChat

API documentation for the static `create` method of the `TencentCloudChat` namespace. This method is the factory function for generating the SDK instance, detailing its parameters and return type.

```APIDOC
TencentCloudChat:
  (static) create(options: Object) -> Object
    Description: Factory function for Tencent Cloud IM Web SDK, used to generate an SDK instance. Before integration, you need to create an IM application in the Tencent Cloud IM console and obtain the `SDKAppID`.
    Parameters:
      options: Object - Configuration options for the SDK instance.
        SDKAppID: Number - Your SDKAppID from the Tencent Cloud IM console.
        proxyServer: String (optional) - WebSocket server proxy address.
        fileUploadProxy: String (optional) - Image, video, file upload proxy address.
        fileDownloadProxy: String (optional) - Image, video, file download proxy address.
    Returns: Object - The SDK instance, typically represented as `chat`.
```

--------------------------------

### User Follow and Fan Management APIs

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SimplifiedMessage

APIs for managing user follow relationships, including following/unfollowing users, retrieving lists of followers and following, checking mutual follow status, and getting user follow information.

```APIDOC
User Follow/Fan Management:
  followUser()
  unfollowUser()
  getMyFollowersList()
  getMyFollowingList()
  getMutualFollowersList()
  getUserFollowInfo()
  checkFollowType()
```

--------------------------------

### TencentCloudChat Namespace API Reference

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/tutorial-05-breakingchanges

Details the structure and available methods within the TencentCloudChat namespace.

```APIDOC
TencentCloudChat:
  - create()
```

--------------------------------

### Get Joined Topic-Supported Community List in Tencent Cloud Chat SDK (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This snippet demonstrates how to fetch a list of communities that support topics using `getJoinedCommunityList`. It includes handling success and error scenarios.

```JavaScript
// Get list of communities that support topics
let promise = chat.getJoinedCommunityList();
promise.then(function(imResponse) { // Successfully retrieved
  console.log(imResponse.data.groupList); // List of communities that support topics
}).catch(function(imError) { // Failed to retrieve
  console.warn('getJoinedCommunityList error:', imError); // Related information for failure
});
```

--------------------------------

### TencentCloudChat Namespace and Create Method

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/GroupMember

Defines the TencentCloudChat namespace and its associated 'create' method, providing an entry point for API interactions.

```APIDOC
Namespaces:
  TencentCloudChat:
    create()
```

--------------------------------

### Tencent Cloud IM SDK Class API Methods

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/FriendGroup

Detailed API documentation for the main SDK class, covering methods for user authentication, message creation and management, conversation handling, group operations, search capabilities, user profile management, status updates, and friend relationship management.

```APIDOC
SDK Class:
  - login()
  - logout()
  - getLoginUser()
  - getServerTime()
  - isReady()
  - destroy()
  - on()
  - off()
  - registerPlugin()
  - setLogLevel()
Message Operations:
  - createTextMessage()
  - createTextAtMessage()
  - createImageMessage()
  - createAudioMessage()
  - createVideoMessage()
  - createCustomMessage()
  - createFaceMessage()
  - createFileMessage()
  - createLocationMessage()
  - createMergerMessage()
  - downloadMergerMessage()
  - createForwardMessage()
  - sendMessage()
  - revokeMessage()
  - resendMessage()
  - deleteMessage()
  - translateText()
  - convertVoiceToText()
  - setMessageExtensions()
  - getMessageExtensions()
  - deleteMessageExtensions()
  - addMessageReaction()
  - removeMessageReaction()
  - getMessageReactions()
  - getAllUserListOfMessageReaction()
Conversation Operations:
  - modifyMessage()
  - getMessageList()
  - getMessageListHopping()
  - sendMessageReadReceipt()
  - getMessageReadReceiptList()
  - getGroupMessageReadMemberList()
  - findMessage()
  - setMessageRead()
  - getConversationList()
  - getConversationProfile()
  - deleteConversation()
  - setConversationDraft()
  - clearHistoryMessage()
  - pinConversation()
  - setAllMessageRead()
  - setMessageRemindType()
  - setAllReceiveMessageOpt()
  - getAllReceiveMessageOpt()
  - getTotalUnreadMessageCount()
Conversation Group Operations:
  - setConversationCustomData()
  - markConversation()
  - getConversationGroupList()
  - createConversationGroup()
  - deleteConversationGroup()
  - renameConversationGroup()
  - addConversationsToGroup()
  - deleteConversationsFromGroup()
Search Operations:
  - searchCloudMessages()
  - searchCloudUsers()
  - searchCloudGroups()
  - searchCloudGroupMembers()
Profile Operations:
  - getMyProfile()
  - getUserProfile()
  - updateMyProfile()
  - getBlacklist()
  - addToBlacklist()
  - removeFromBlacklist()
User Status Operations:
  - setSelfStatus()
  - getUserStatus()
  - subscribeUserStatus()
  - unsubscribeUserStatus()
Relationship Operations:
  - getFriendList()
  - addFriend()
  - deleteFriend()
  - checkFriend()
  - getFriendProfile()
  - updateFriend()
  - getFriendApplicationList()
  - acceptFriendApplication()
  - refuseFriendApplication()
```

--------------------------------

### Dismiss Group and Delete All Topics in Tencent Cloud Chat SDK (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This example shows how to dismiss an entire group, which implicitly deletes all topics associated with that group. It handles the success and error callbacks for the `dismissGroup` operation.

```JavaScript
// Dismiss community, delete all topics under this community
let promise = chat.dismissGroup('group1');
promise.then(function(imResponse) { // Successfully dismissed
  console.log(imResponse.data.groupID); // Dismissed group ID
}).catch(function(imError) {
  console.warn('dismissGroup error:', imError); // Related information for group dismissal failed
});
```

--------------------------------

### Send Message to Topic in Tencent Cloud Chat SDK (JavaScript)

Source: https://web.sdk.qcloud.com/im/doc/v3/zh-cn/index.html/SDK

This example illustrates how to send a text message to a specific topic within a community. It shows how to construct the `to` field using the topic ID and set the `conversationType`.

```JavaScript
// Send message to topic
let message = chat.createTextMessage({
  to: '@TGS#_@TGS#cWWFWHIM62CL@TOPIC#_@TOPIC#cXWFWHIM62CR', // Topic ID
  conversationType: TencentCloudChat.TYPES.CONV_GROUP,
  payload: {
    text: 'Hello world!'
  }
});
// Send message
let promise = chat.sendMessage(message);
promise.then(function(imResponse) {
  // Successfully sent
  console.log(imResponse);
}).catch(function(imError) {
  // Failed to send
  console.warn('sendMessage error:', imError);
});
```
Tokens:
Raw