AI Integration Quick Reference
AI Integration Quick Reference
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
- 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.
- TypeScript
- JavaScript
MessageReceipt objects containing the following parameters:
The
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.
The following features require Enhanced Messaging Status to be enabled for your app:
onMessagesDeliveredToAlleventonMessagesReadByAlleventdeliveredAtfield in group messagesreadAtfield in group messagesmarkMessageAsUnread()method
MessageReceipt Object
The listener callbacks receive aMessageReceipt object:
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.
Mark as Unread
UsemarkMessageAsUnread() to mark a message as unread. This is useful for “mark as unread” functionality in conversation lists.
You cannot mark your own messages as unread. This method only works for messages received from other users.
- TypeScript
- JavaScript
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