please select
  • UIKit
  • SDK
  • Server APIs
Chat/
UIKit/
Android/
Features/
UIKit
  • Overview
  • Run Demo
  • Getting Started
  • Installation
    • TUIKit
    • TUIChat Only
  • Build Basic Interfaces
    • Chat
    • Conversation List
    • Contact List
    • Add Contact
    • Create Group Chat
    • Video and Audio Call
  • Features
    • Reactions
    • Quote
    • Read Receipt
    • User Online Status
    • Translation
    • Voice to Text
    • Search Messages
  • Customization
    • Customize Messages
    • Customize Emojis and Stickers
  • Localization
  • Changelog
  • Guideline for Beginners
  • Console Guide
    • Creating and Upgrading an Application
    • Basic Configuration
    • Feature Configuration
    • Account Management
    • Group Management
    • Webhook Configuration
  • Product Introduction
    • Message Management
      • One-to-One Message
      • Message Storage
      • Offline Push
      • Group Message
      • Message Formats
    • Account System
      • Login Authentication
      • Online Status Management
    • Group Related
      • Group System
      • Group Management
    • User Profile and Relationship Chain
      • Profile Management
      • Relationship Chain Management
  • Purchase Guide
    • Billing Overview
    • Pricing
  • Error Codes

Read Receipt

Description

Read Receipt is used to notify the sender that "the recipient has read the sent message". When the recipient reads the message, a read message is reported, the backend system will generate a notification to inform the sender that the message has been viewed.
In instant messaging tools (WhatsApp, WeChat, etc.), when the recipient views the message, the sender will see a read receipt next to the message, such as a blue check mark or the word "read".
Note:
"Receipt" means "Reply Receipt", which represents a credential for confirming receipt. When you send a message and request a receipt, you are actually asking the other party "I want to confirm whether you have received and read my message". This confirmation is like a "receipt", proving that your message has been received.
Read receipts help ensure important messages has been viewed but can also cause psychological stress and privacy issues. Therefore, we support users to turn off the read receipt feature.
Note:
1. This feature is only supported by the premium edition. Please purchase the premium edition to use it.
2. "Group Chat Message Read Receipt" is supported from TUIKit 6.2.2363 version and later.
3. "One-to-one Chat Message Read Receipt" is supported from TUIKit 6.3.2609 version and later.

Effect

One-to-one Chat Message Read Receipt

Indicated by ✔️ or highlighted ✔️✔️ on the message


Group Chat Message Read Receipt

Message reading status is indicated on the message:
When no one has read it, ✔️ is displayed;
When some chat members have read it, gray ✔️✔️ is displayed;
When everyone has read it, highlighted ✔️✔️ is displayed.

Message List



Read Receipt Details

Click the read status to enter the read receipt details page.


Enabling Message Read Receipt

In the TUIChat component, within the GeneralConfig.java file, a switch for the "Message Read Receipt" feature, named msgNeedReadReceipt, is provided. Its type is boolean, with a default value of false.
public class GeneralConfig {
private boolean msgNeedReadReceipt = false;
}
If you want to enable the "Message Read Receipt" feature, please first activate the premium edition and then change the default value of msgNeedReadReceipt to true, or call the following method to enable it before the chat page is initialized.
TUIChatConfigs.getConfigs().getGeneralConfig().setMsgNeedReadReceipt(true);

FAQs

Error: The usage of this API is not supported by the package. Please upgrade to the premium edition.
The "Message Read Receipt" feature is only supported by the premium package. This error message indicates that your current package does not support this capability. Please log in to the Chat purchase page to activate the premium edition for experience.