Unread Count (Web & Mini Programs)

Last updated: 2020-03-09 12:22:07

    Unread messages are messages that have not been reported as read by users. This does not indicate whether the recipient has actually read the messages. To display the correct unread count, developers need to explicitly call read reports to notify the IM SDK whether the messages in a conversation are read. For example, you can mark all messages as read when the user enters the chat UI.

    Obtaining the Current Unread Count

    Every time you use getConversationList(), you will obtain a [ConversationConversation, …] array. Each Conversation has an unread count for the current conversation, which is represented by unreadCount.
    The unread count of all conversations is the sum of the unreadCount values of each conversation.

    Read Reports

    When the user reads a message in a conversation, a read report is sent, and the IM SDK sets all messages before the last read message as read. We recommend that you send read reports when the user clicks to switch between conversations.

    Read reports change the unread count of a conversation, but do not push read receipts to the message sender.




    The options parameter is of the Object type. The attribute it contains is described in the following table:

    Name Type Description
    conversationID String Conversation ID


    // Send read reports for all unread messages in a conversation
    tim.setMessageRead({conversationID: 'C2Cexample'});

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback