Quick Reference for AI Agents & Developers
Mark Messages as Delivered
How do I inform the sender that I’ve received a message? You can mark the messages for a particular conversation as read using themarkAsDelivered() method. This method takes the following parameters as input:
| Parameter | Information |
|---|---|
messageId | The ID of the message above which all the messages for a particular conversation are to be marked as read. |
receiverId | In case of one to one conversation message’s sender UID will be the receipt’s receiver Id. In case of group conversation message’s receiver Id will be the receipt’s receiver Id. |
receiverType | Type of the receiver. Could be either of the two values (user/group). |
senderId | The UID of the sender of the message. |
- When the list of messages for the conversation is fetched: In this case you need to obtain the last message in the list of messages and pass the message ID of that message to the markAsDelivered() method.
- When the user is on the chat window and a real-time message is received: In this case you need to obtain the message ID of the message and pass it to the markAsDelivered() method.
- Java (User)
- Kotlin (User)
- Java (Group)
- Kotlin (Group)
markAsDelivered() method with the callbacks as shown below:
- Java (User)
- Java (Group)
- Kotlin (User)
- Kotlin (Group)
- Java
- Kotlin
markAsDelivered() method with the callbacks as shown below:
- Java
- Kotlin
Starting v3, the messages will not be marked delivered internally by the SDK. You will have to use the
markAsDelivered() method. You will either have to use one of the above method signatures to mark the messages as delivered.Mark Messages as Read
How do I inform the sender I’ve read a message? You can mark the messages for a particular conversation as read using themarkAsRead() method. This method takes the following parameters as input:
| Parameter | Information |
|---|---|
messageId | The ID of the message above which all messages for a particular conversation are to be marked as read. |
receiverId | In case of one to one conversation message’s sender UID will be the receipt’s receiver Id. In case of group conversation message’s receiver Id will be the receipts’s receiver Id |
receiverType | Type of the receiver. Could be either of the two values (user/group). The possible values are: 1. CometChatConstants.RECEIVER_TYPE_USER 2. CometChatConstants.RECEIVER_TYPE_GROUP |
senderId | The UID of the sender of the message |
- When the list of messages for the conversation is fetched: In this case you need to obtain the last message in the list of messages and pass the message ID of that message to the
markAsRead()method. - When the user is on the chat window and a real-time message is received: In this case you need to obtain the message ID of the message and pass it to the
markAsRead()method
- Java (User Conversation)
- Kotlin (User Conversation)
- Java (Group Conversation)
- Kotlin (Group Conversation)
receiverId and receiverType (user/group) as read.
In case you would like to be notified of an error if the receipts fail to go through you can use the markAsRead() method with the callbacks as shown below:
- Java (User)
- Java (Group)
- Kotlin (User)
- Kotlin (Group)
- Java
- Kotlin
markAsRead() method with the callbacks as shown below:
- Java
- Kotlin
Starting v3, the
markAsRead() method working with v2.x is deprecated and will not work. You will either have to use one of the above method signatures to mark the messages as read.Mark Messages as Unread
The Mark as Unread feature allows users to designate specific messages or conversations as unread, even if they have been previously viewed. This feature is valuable for users who want to revisit and respond to important messages or conversations later, ensuring they don’t forget or overlook them. In other words, how I can mark a message as unread? You can mark the messages for a particular conversation as unread using themarkAsUnread() method. This method takes the below parameters as input:
| Parameter | Information |
|---|---|
| message | To mark a message as unread, pass a non-null BaseMessage instance to the markAsUnread() function. All messages below that message in the conversation will contribute to the unread messages count. Example: When User B sends User A a total of 10 messages, and User A invokes the markAsUnread() method on the fifth message, all messages located below the fifth message within the conversation list will be designated as unread. This results in a notification indicating there are 5 unread messages in the conversation list. |
| listener | The callback listener that will be called on success or error. This should be a non-null CallbackListener instance. |
- Java (User)
- Kotlin (User)
- Java (Group)
- Kotlin (Group)
Receive Delivery & Read Receipts
How do I know when a message I sent has been delivered or read by someone?Real-time events
onMessagesDelivered()- This event is triggered when a message is delivered to a user.onMessagesRead()- This event is triggered when a message is read by a user.onMessagesDeliveredToAll()- This event is triggered when a group message is delivered to all members of the group. This event is only for Group conversations.onMessagesReadByAll()- This event is triggered when a group message is read by all members of the group. This event is only for Group conversations.
- Java
- Kotlin
MessageReceipt objects. The message receipt contains the following parameters:
| Parameter | Information |
|---|---|
messageId | The Id of the message prior to which all the messages for that particular conversation have been marked as read. |
sender | User object containing the details of the user who has marked the message as read. System User for deliveredToAll & readByAll events. |
receiverId | Id of the receiver whose conversation has been marked as read. |
receiverType | type of the receiver (user/group) |
receiptType | Type of the receipt (read/delivered) |
deliveredAt | The timestamp of the time when the message was delivered. This will only be present if the receiptType is delivered. |
readAt | The timestamp of the time when the message was read. This will only be present when the receiptType is read. |
Missed Receipts
You will receive message receipts when you load offline messages. While fetching messages in bulk, the message object will have two fields i.e.deliveredAt and readAt which hold the timestamp for the time the message was delivered and read respectively. Using these two variables, the delivery and read status for a message can be obtained.
However, for a group message, if you wish to fetch the deliveredAt and readAt fields of individual member of the group you can use the below-described method.
Receipt History for a Single Message
To fetch the message receipts, you can use thegetMessageReceipts() method.
- Java
- Kotlin
MessageReceipt objects in the onSuccess() method.
The following features will be available only if the Enhanced Messaging Status feature is enabled for your app.
onMessagesDeliveredToAllevent,onMessagesReadByAllevent,deliveredAtfield in a group message,readAtfield in a group message.markAsUnreadmethod.
Best Practices
Mark as Delivered on Message Fetch
Mark as Delivered on Message Fetch
Call
markAsDelivered() when fetching messages and when receiving real-time messages to ensure senders know their messages were received.Mark as Read When Visible
Mark as Read When Visible
Call
markAsRead() only when messages are actually visible to the user (e.g., when chat window is open and focused) for accurate read status.Use Message Object Overload
Use Message Object Overload
Use
markAsDelivered(message) and markAsRead(message) overloads for simpler code when you have the message object available.Handle Receipt Events for UI Updates
Handle Receipt Events for UI Updates
Listen for receipt events to update your UI with delivery/read indicators (checkmarks) in real-time.
Enable Enhanced Messaging Status
Enable Enhanced Messaging Status
Enable “Enhanced Messaging Status” in Dashboard for group message receipts and advanced features like
markAsUnread.Troubleshooting
Receipts Not Sending
Receipts Not Sending
Symptom:
markAsDelivered() or markAsRead() fails silently.Cause: User not logged in, or incorrect parameters provided.Solution: Verify user is logged in using CometChat.getLoggedInUser(). Use the callback version of methods to catch errors.Group Receipts Not Working
Group Receipts Not Working
Symptom:
onMessagesDeliveredToAll or onMessagesReadByAll not triggered.Cause: “Enhanced Messaging Status” feature not enabled in Dashboard.Solution: Enable the feature in CometChat Dashboard under your app settings.Receipt Events Not Received
Receipt Events Not Received
Symptom: Receipt listener methods not being called.Cause: Message listener not registered or removed prematurely.Solution: Ensure
addMessageListener() is called before messages are sent/received. Don’t remove listeners while still needed.