Teams: Read receipts

[clearab]

Add support for read receipts in 1-1 chats in Teams.

[YunnyChung]

Also BF team is exposing a helper method in the SDK, which basically compares the message ids to decide whether a specific message sent by a bot was read or not.

Pseudo code:
bool IsMessageRead(string idOfMessageBotCares, string userLastReadMessageId)

• if idOfMessageBotCares < userLastReadMessageId ==> the user read the bot's message.

Please add the following to intellisense:

• (1) idOfMessageBotCares should be the id of a message sent by a bot.
• (2) idOfMessageBotCares and userLastReadMessageId should be in the same thread.

[YunnyChung]

The below is the final payload that SMBA sends to a bot.

[YunnyChung]

This feature is mainly for LOB company communicator bots.
This is the pseudocode for the bot.

Context: the company communicator bot wants to know how many users have or have not read the messages sent by the bot.

1. The company communicator bot sends an announcement message to everyone in the tenant.

• The bot needs to save the {threadId: messageId} for each thread. Here the message id is the id of the message that the bot wants to know whether the user read it or not.

2. As time passes, each user starts to read the message. This action will generate the read receipt event.
3. The bot receives the read receipt event which contains the thread id and the id of the message read by the user in that thread.
4. The bot queries the id of the message that it wants to know the read status of from its database using the thread id.
5. Then use SDK helper method IsMessageRead(string idOfMessageBotCares, string userLastReadMessageId) to check whether the user read the bot's message. userLastReadMessageId is coming from the read receipt event payload.
6. If IsMessageRead returns true, count +=1 (assuming the bot has the global counter).

[YunnyChung]

This is the sample code for the BF SDK helper method IsMessageRead

// Bot SDK helper method.
// idOfMessageBotCares: we expect the bot developers to track the id of message that they want to track per thread.
// userLastReadMessageId: the id in the event payload.

public bool IsMessageRead(string idOfMessageBotCares, string userLastReadMessageId)
{
    if (String.IsNullOrEmpty(idOfMessageBotCares) || String.IsNullOrEmpty(userLastReadMessageId))
    {
        return false;
    }

    long.TryParse(idOfMessageBotCares, out long idOfMessageBotCaresLong);
    long.TryParse(userLastReadMessageId, out long userLastReadMessageIdLong);

    // if idOfMessageBotCares is smaller than userLastReadMessageId, it means the user read the bot's message. 
    return (idOfMessageBotCares.CompareTo(userLastReadMessageId) <= 0) ? true : false;
}

[YunnyChung]

This is how I am currently consuming a read receipt event on my testing bot.

protected override async Task OnEventActivityAsync(
    ITurnContext<IEventActivity> turnContext, CancellationToken cancellationToken)
{
    var eventType = turnContext.Activity.Name;
    if (!eventType.Contains("readreceipt", StringComparison.InvariantCultureIgnoreCase))
    {
        return;
    }

    var lastReadMessageIdJObject = turnContext.Activity.Value as JObject; // get a user's read status
    var lastReadMessageId = lastReadMessageIdJObject["lastReadMessageId"].ToString(); // get the user's last read message id
    var threadId = turnContext.Activity.Conversation.Id;

    if (_trackTheMessageBotCaresPerThread.ContainsKey(threadId))
    {
        // readReceiptObject is the object that I created as a bot developer to track necessary information for the message that my bot cares.
        ReadReceiptObject readReceiptObject = _trackTheMessageBotCaresPerThread[threadId];
        bool isMessageRead = IsMessageRead(readReceiptObject.botSentMessageId, lastReadMessageId); // call BF SDK's helper method
        
        // the below line is helpful when a bot developer wants to do something for
        // messages that were read vs messages that were not read.
        // ex: Bot developers can query all the messages that were not read and follow up differently.
        readReceiptObject.isMessageRead = isMessageRead;
    }
}

[dalmonn]

Hi, we are triying to do the same in our bot, almost the same implementation, we noticed that you added the event but we are not finding the way to receive that event.
I mean, we send a message to a user, but when the user open the conversation the event it's not sending to the bot.
Do we need to add something to receive that message? We allow the permission ChatMessageReadReceipt.Read.Chat when the bot it's installed on teams but it's not working.

[danielmacedo90]

I have the same scenario as @dalmonn.

I added the RSC permission in the manifest, but the event is not being sent to the bot.

"webApplicationInfo": {
        "id": "xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "resource": "https://RscBasedStoreApp"
    },
    "authorization": {
        "permissions": {
          "resourceSpecific": [
            {
              "name": "ChatMessageReadReceipt.Read.Chat",
              "type": "Application"
            }
          ]
        }
    }

Any other necessary settings missing?