Delivery & Read Receipts

Mark Messages as Delivered

In other words, as a recipient, how do I inform the sender that I've received a message?

You can mark the messages for a particular conversation as read using the markAsDelivered() method. This method takes the below parameters as input:

messageId	The ID of the message above which all the messages for a particular conversation are to be marked as read.
receiverId	In the case of one-to-one conversation, the sender'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 or group)
messageSender	The UID of the sender of the message.

Messages for both user conversation and group conversation can be marked as delivered using this method.

Ideally, you should mark all the messages as read for any conversation when the user opens the chat window for that conversation. This includes two scenarios:

1. 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.
2. 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.

Swift(User)

var messageId = 123
var receiverId = "superhero2"
var senderId = "superhero1"
CometChat.markAsDelivered(messageId: messageId, receiverId: receiverId, receiverType: .user, messageSender: senderId)

Swift(Group)

var messageId = 123
var receiverId = "superhero2"
var senderId = "superhero1"
CometChat.markAsDelivered(messageId: messageId, receiverId: receiverId, receiverType: .group, messageSender: senderId)

Objective C(User)

[CometChat markAsDeliveredWithMessageId:messageId receiverId:receiverId receiverType: ReceiverTypeUser messageSender:messageSender]

Objective C(Group)

[CometChat markAsDeliveredWithMessageId:messageId receiverId:receiverId receiverType: ReceiverTypeUser messageSender:messageSender]

This method will mark all the messages before the messageId specified, for the conversation with 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 markAsDelivered() method with the callbacks as shown below:

Swift(User)

var messageId = 123
var receiverId = "superhero2"
var senderId = "superhero1"
CometChat.markAsDelivered(messageId: messageId, receiverId: receiverId, receiverType: .user, messageSender: senderId, onSuccess: {
    print("markAsDelivered Succces")
}, onError: {(error) in
  print("markAsDelivered error message",error?.errorDescription)
})

Swift(Group)

var messageId = 123
var receiverId = "superhero2"
var senderId = "superhero1"
CometChat.markAsDelivered(messageId: messageId, receiverId: receiverId, receiverType: .group, messageSender: senderId, onSuccess: {
    print("markAsDelivered Succces")
}, onError: {(error) in
  print("markAsDelivered error message",error?.errorDescription)
})

Objective C(User)

int messageId = 123;
NSString *receiverId = @"superhero2";
NSString *senderId = @"superhero1";
[CometChat markAsDeliveredWithMessageId:messageId receiverId:receiverId receiverType: ReceiverTypeUser messageSender:messageSender onSuccess:^{
    NSLog(@"markAsDelivered Success");
} onError:^(CometChatException *error){
  NSLog(@"markAsDelivered error message %@",[error errorDescription]);
}];

Objective C(Group)

int messageId = 123;
NSString *receiverId = @"superhero2";
NSString *senderId = @"superhero1";
[CometChat markAsDeliveredWithMessageId:messageId receiverId:receiverId receiverType: ReceiverTypeGroup messageSender:messageSender onSuccess:^{
    NSLog(@"markAsDelivered Success");
} onError:^(CometChatException *error){
  NSLog(@"markAsDelivered error message %@",[error errorDescription]);
}];

Another option the CometChat SDK provides is to pass the entire message object to the markAsDelivered() method.

Swift

CometChat.markAsDelivered(baseMessage : baseMessage)

Objective C

[CometChat markAsDeliveredWithBaseMessage:baseMessage];

In case you would like to be notified of an error if the receipts fail to go through you can use markAsDelivered() method with the callbacks as shown below:

Swift

CometChat.markAsDelivered(baseMessage : baseMessage, onSuccess: {
    print("markAsDelivered Succces")
}, onError: {(error) in
  print("markAsDelivered error message",error?.errorDescription)
})

Objective C

[CometChat markAsDeliveredWithBaseMessage:baseMessage onSuccess:^{
    NSLog(@"markAsDelivered Success");
} onError:^(CometChatException *error){
  NSLog(@"markAsDelivered error message %@",[error errorDescription]);
}];

info

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

In other words, as a recipient, how do I inform the sender I've read a message?

You can mark the messages for a particular conversation as read using the markAsRead() method. This method takes the below 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 receipts's receiver Id
receiverType	type of the receiver. Could be either of the two values( user or group)
messageSender	The UID of the sender of the message.

Messages for both User conversation and Groups can be marked as read using this method.

Ideally, you would like to mark all the messages as read for any conversation when the user opens the chat window for that conversation. This includes two scenarios:

1. 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.
2. 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

Swift(User)

var messageId = 123
var receiverId = "abc"
var senderId = "xyz"

CometChat.markAsRead(messageId: messageId, receiverId: receiverId, receiverType: .user, messageSender: senderId)

Swift(Group)

var messageId = 123
var receiverId = "abc"

CometChat.markAsRead(messageId: messageId, receiverId: receiverId, receiverType: .group)

Objective C(User)

int messageId = 123;
NSString *receiverId = "abc";

[CometChat markAsReadWithMessageId:messageId receiverId:receiverId receiverType:ReceiverTypeUser];

Objective C(Group)

int messageId = 123;
NSString *receiverId = "abc";

[CometChat markAsReadWithMessageId:messageId receiverId:receiverId receiverType:ReceiverTypeUser];

This method will mark all the messages before the messageId specified, for the conversation with 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:

Swift(User)

var messageId = 123
var receiverId = "superhero2"
var senderId = "superhero1"
CometChat.markAsRead(messageId: messageId, receiverId: receiverId, receiverType: .user, messageSender: senderId, onSuccess: {
    print("markAsRead Succces")
}, onError: {(error) in
  print("markAsRead error message",error?.errorDescription)
})

Swift(Group)

var messageId = 123
var receiverId = "superhero2"
var senderId = "superhero1"
CometChat.markAsRead(messageId: messageId, receiverId: receiverId, receiverType: .group, messageSender: senderId, onSuccess: {
    print("markAsRead Succces")
}, onError: {(error) in
  print("markAsRead error message",error?.errorDescription)
})

Objective C(User)

int messageId = 123;
NSString *receiverId = "abc";

[CometChat markAsReadWithMessageId:messageId receiverId:receiverId receiverType:ReceiverTypeUser onSuccess:^{
    NSLog(@"markAsRead Success");
} onError:^(CometChatException *error){
  NSLog(@"markAsRead error message %@",[error errorDescription]);
}];

Objective C(Group)

int messageId = 123;
NSString *receiverId = "abc";

[CometChat markAsReadWithMessageId:messageId receiverId:receiverId receiverType:ReceiverTypeGroup onSuccess:^{
    NSLog(@"markAsRead Success");
} onError:^(CometChatException *error){
  NSLog(@"markAsRead error message %@",[error errorDescription]);
}];

Another option the CometChat SDK provides is to pass the entire message object to the markAsRead() method.

Swift

CometChat.markAsRead(baseMessage : baseMessage)

Objective C

[CometChat markAsReadWithBaseMessage: baseMessage];

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:

Swift

var messageId = 123
var receiverId = "superhero2"
var senderId = "superhero1"
CometChat.markAsRead(baseMessage : baseMessage, onSuccess: {
    print("markAsRead Succces")
}, onError: {(error) in
  print("markAsRead error message",error?.errorDescription)
})

Objective C

[CometChat markAsReadWithBaseMessage: baseMessage onSuccess:^{
    NSLog(@"markAsRead Success");
} onError:^(CometChatException *error){
  NSLog(@"markAsRead error message %@",[error errorDescription]);
}];

info

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 message as unread?

You can mark the messages for a particular conversation as unread using the markAsUnread() method. This method takes the below parameters as input:

Field	Information
conversationId	id of the conversation
conversationType	type of conversation (user/group)
lastMessage	last message in the conversation
conversationWith	User or Group object containing the details
unreadMessageCount	unread message count for the conversation
unreadMentionsCount	count of unread mentions in the conversation
lastReadMessageId	ID of the last read message in the conversation

Swift

let txt = TextMessage(receiverUid: "superhero3", text: "this is unread count test", receiverType: .user)
txt.id = 3 // the message with id 3 will be marked unread. ID is required.
txt.sender = User(uid: "superhero2", name: "Captain America")

CometChat.markAsUnread(baseMessage: txt) {
         print("markAsUnread executed successfully: on message with ID: \(txt.id) and text \(txt.text)")
} onError: { error in
         print("markAsUnread not executed error: \(error?.errorDescription)")
}

Receive Delivery & Read Receipts

In other words, as a recipient, how do I know when a message I sent has been delivered or read by someone?

Real-time Receipts

Real-time events for messages of a conversation being read or delivered can be obtained in the onMessagesRead() and the onMessagesDelivered() methods of the CometChatMessageDelegate. In order to receive typing indicators, you must add protocol conformance CometChatMessageDelegate.

Swift

func onMessagesRead(receipt: MessageReceipt) {
    
   print("onMessagesRead \(receipt.stringValue())")
 }
    
 func onMessagesDelivered(receipt: MessageReceipt) {
        
  print("onMessagesDelivered \(receipt.stringValue())")
 }

Objective C

-(void)onMessagesDeliveredWithReceipt:(MessageReceipt *)receipt
{
   NSLog(@"onMessagesDeliveredWithReceipt %@",receipt.stringValue)
}
-(void)onMessagesReadWithReceipt:(MessageReceipt *)receipt
{
   NSLog(@"onMessagesReadWithReceipt %@",receipt.stringValue)
}

You will receive events in the form of 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.
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.

While fetching messages in bulk, if the message is a part of a user conversation, the message object will have two fields viz. 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 user message can be obtained.

However, for a group message, the deliveredAt and readAt fields are never set and hence to get the status of the message you can use the below-described method.

Missed Receipts

You will receive message receipts when you load offline messages. For groups, we do not include the list the users that have received it. You need to call the getMessageReceipts() method for it.

Receipt History for a Single Message

In order to fetch the message receipts, you can use the getMessageReceipts() method.

Swift

var messageId = 10101;

CometChat.getMessageReceipts(messageId, onSuccess: { (receipt) in
            
  print("getMessageReceipt \(receipt)")                                           
}) { (error) in
  print(error?.errorDescription)
}

Objective C

int messageId =10101;

[CometChat getMessageReceipts:messageId onSuccess:^(NSArray<MessageReceipt *> * _Nonnull receipt) {
        
        NSLog(@"getMesssageReceipts %@",receipt);
    } onError:^(CometChatException * _Nullable error) {
        
        NSLog(@"CometChatException %@",error.errorDescription);
    }];

You will receive a list of MessageReceipt objects in the onSuccess() method.