tencent cloud

All product documents
Chat
DocumentationChatNo UI IntegrationConversationConversation ListJavaScript
JavaScript
Download PDF
Last updated: 2025-01-07 15:57:32
JavaScript
Last updated: 2025-01-07 15:57:32
Download PDF

Feature Overview

With conversation lists, users can easily locate target conversations after they log in to the application.
The conversation list feature includes getting the conversation list and listening for conversation list update events.
The core data structure is Conversation.

Getting the Conversation List

Call the getConversationList API on the access side to get the conversation list.
API
chat.getConversationList(options);
Parameters
Name
Type
Description
options
undefined | Array | Object
If options is undefined, the SDK will return all the conversations.
if options is of the Array type, it shall not be empty, the SDK will return specified conversations.
if options is of the Object type, as {type, markType, groupName}, the SDK will return filtered conversations.
Return value
Promise
Examples 
// Get the full conversation list
let promise = chat.getConversationList();
promise.then(function(imResponse) {
// This full conversation list will overwrite the original conversation list.
  const conversationList = imResponse.data.conversationList;
  // Whether synchronizing the conversation list from the cloud is completed
  const isSyncCompleted = imResponse.data.isSyncCompleted;
}).catch(function(imError){
  console.warn('getConversationList error:', imError); // Error information
});
// Get the list of specified conversations
let promise = chat.getConversationList([conversationID1, conversationID2]);
promise.then(function(imResponse) {
  // List of specified conversations that already exist in the cache
  const conversationList = imResponse.data.conversationList;
}).catch(function(imError){
  console.warn('getConversationList error:', imError); // Error information
});
// Get all group conversations
let promise = chat.getConversationList({ type: TencentCloudChat.TYPES.CONV_GROUP });
promise.then(function(imResponse) {
  const conversationList = imResponse.data.conversationList; // Conversation list
});
// Get all conversations that are marked as "favorite"
let promise = chat.getConversationList({ markType: TencentCloudChat.TYPES.CONV_MARK_TYPE_STAR });
promise.then(function(imResponse) {
  const conversationList = imResponse.data.conversationList; // Conversation list
});
// Get all unmarked conversations (supported from v3.3.0 onwards)
let promise = chat.getConversationList({ markType: 0 });
promise.then(function(imResponse) {
  const conversationList = imResponse.data.conversationList; // Conversation list
});
// Get all conversations in a specified conversation group
let promise = chat.getConversationList({ groupName: 'Suppliers' });
promise.then(function(imResponse) {
  const conversationList = imResponse.data.conversationList; // Conversation list
});
// Get conversations that do not belong to any group (supported from v3.3.0 onwards)
let promise = chat.getConversationList({ groupName: '' });
promise.then(function(imResponse) {
  const conversationList = imResponse.data.conversationList; // Conversation list
});
// Get conversations with unread counts (supported from v3.3.0 onwards)
let promise = chat.getConversationList({ hasUnreadCount: true });
promise.then(function(imResponse) {
  const conversationList = imResponse.data.conversationList; // Conversation list
});
// Get conversations with group @ messages (supported from v3.3.0 onwards)
let promise = chat.getConversationList({ hasGroupAtInfo: true });
promise.then(function(imResponse) {
  const conversationList = imResponse.data.conversationList; // Conversation List
});

Listening for Conversation List Update Events

Listen for TencentCloudChat.EVENT.CONVERSATION_LIST_UPDATED events on the access side to get conversation list update notifications.
Examples
let onConversationListUpdated = function(event) {
  console.log(event.data); // Array that stores Conversation instances
};
chat.on(TencentCloudChat.EVENT.CONVERSATION_LIST_UPDATED, onConversationListUpdated);

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon