AI Integration Quick Reference
AI Integration Quick Reference
| Method | Description |
|---|---|
markAsDelivered(message) | Mark a message as delivered |
markAsRead(message) | Mark a message as read |
markConversationAsDelivered(id, type) | Mark entire conversation as delivered |
markConversationAsRead(id, type) | Mark entire conversation as read |
markMessageAsUnread(message) | Mark a message as unread |
getMessageReceipts(messageId) | Get delivery/read receipts for a message |
Mark as Delivered
UsemarkAsDelivered() to mark messages as delivered. You can pass either a message object or individual parameters.
Using Message Object
- TypeScript
- JavaScript
Using Parameters
| Parameter | Description |
|---|---|
messageId | ID of the message to mark as delivered |
receiverId | For user chats: sender’s UID. For groups: group GUID |
receiverType | "user" or "group" |
senderId | UID of the message sender |
- TypeScript (User)
- JavaScript (User)
- TypeScript (Group)
- JavaScript (Group)
Mark Conversation as Delivered
UsemarkConversationAsDelivered() to mark all messages in a conversation as delivered.
markConversationAsDelivered() resolves with a string on success.
- TypeScript (User)
- JavaScript (User)
- TypeScript (Group)
- JavaScript (Group)
Mark as Read
UsemarkAsRead() to mark messages as read. You can pass either a message object or individual parameters.
Using Message Object
- TypeScript
- JavaScript
Using Parameters
- TypeScript (User)
- JavaScript (User)
- TypeScript (Group)
- JavaScript (Group)
Mark Conversation as Read
UsemarkConversationAsRead() to mark all messages in a conversation as read.
- TypeScript (User)
- JavaScript (User)
- TypeScript (Group)
- JavaScript (Group)
Real-Time Receipt Events
Register aMessageListener to receive delivery and read receipt events.
| Callback | Description |
|---|---|
onMessagesDelivered | Message delivered to a user |
onMessagesRead | Message read by a user |
onMessagesDeliveredToAll | Group message delivered to all members |
onMessagesReadByAll | Group message read by all members |
- TypeScript
- JavaScript
MessageReceipt objects. The message receipt contains the below 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. |
markAsDelivered() and markAsRead() methods are fire-and-forget — they do not return a MessageReceipt object. Use the listener callbacks above to receive delivery and read confirmations.
You will receive a list of MessageReceipt objects.
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.markMessageAsUnreadmethod.
MessageReceipt Object
The listener callbacks receive aMessageReceipt object:
| Field | Getter | Return Type | Description |
|---|---|---|---|
| messageId | getMessageId() | string | ID of the message |
| sender | getSender() | User | User who triggered the receipt |
| receiverId | getReceiverId() | string | ID of the receiver |
| receiverType | getReceiverType() | string | "user" or "group" |
| receiptType | getReceiptType() | string | "delivery" or "read" |
| deliveredAt | getDeliveredAt() | number | Timestamp when delivered |
| readAt | getReadAt() | number | Timestamp when read |
Get Receipt History
UsegetMessageReceipts() to fetch delivery and read receipts for a specific message. Useful for group messages to see which members have received/read the message.
- TypeScript
- JavaScript
MessageReceipt objects.
Missed Receipts
When fetching messages, each message object includesdeliveredAt and readAt timestamps indicating when the message was delivered and read.
The following features require Enhanced Messaging Status to be enabled for your app:
onMessagesDeliveredToAlleventonMessagesReadByAlleventdeliveredAtfield in group messagesreadAtfield in group messagesmarkMessageAsUnread()method
Mark as Unread
UsemarkAsUnread() to mark a message as unread. This is useful for “mark as unread” functionality in conversation lists. Pass a message object (TextMessage, MediaMessage, or CustomMessage).
- TypeScript
- JavaScript
| Parameter | Type | Description |
|---|---|---|
message | BaseMessage | The message object to mark as unread |
Next Steps
Typing Indicators
Show real-time typing status in conversations
Receive Messages
Listen for incoming messages in real time
Retrieve Conversations
Fetch conversation list with unread counts
All Real-Time Listeners
Complete reference for all SDK event listeners