Skip to content

Conversation

glorialimicrosoft
Copy link
Member

@glorialimicrosoft glorialimicrosoft commented Jul 28, 2025

🧠 Core Concept:

Message Read Receipts and Typing Indicator Updates are lightweight sent by the business (via ACS) to update the delivery state of a previously received message — such as marking it as read, or indicating the business is typing a response.

Copy link

openapi-pipeline-app bot commented Jul 28, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ The required check named TypeSpec Validation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

Copy link

openapi-pipeline-app bot commented Jul 28, 2025

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

Copy link

github-actions bot commented Jul 28, 2025

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language API Review for Package
Swagger CallAutomation-Messages
TypeSpec Azure.Communication.MessagesService
Java com.azure:azure-communication-messages
JavaScript @azure-rest/communication-messages
C# Azure.Communication.Messages

@glorialimicrosoft
Copy link
Member Author

glorialimicrosoft commented Jul 28, 2025

💬 Hero Scenarios: Read Receipt & Typing Indicator in ACS


✅ Scenario 1: "Is My Message Seen?" – Customer Support Confirmation

User Story:
As a user texting a business on WhatsApp, I want to know when the business has received and read my message so I don’t feel ignored.

Flow:

  1. Customer sends a message to the business WhatsApp account.
  2. ACS processes the incoming message.
  3. Agent or bot reads the message.
  4. Read receipt is sent to WhatsApp via ACS.

Code Example:

POST /messages/readreceipts:send
Content-Type: application/json

{
  "messageId": "d3b54e2e-a723-4b0b-b4bb-162d6506e441",
  "channelRegistrationId": "c987fbc0-1c8f-4ff9-b505-6a7a0d2f1450",
}

✅ Scenario 2: "Typing…" – Real-Time Responsiveness Indicator

User Story:
As a customer, I want to see when the agent or bot is actively typing so I know a response is coming soon and don’t exit the conversation.

Flow:

  1. Customer sends a message.
  2. Bot begins generating a response.
  3. Bot sends a read status update with typingIndicator: true.
  4. WhatsApp shows the typing bubble.
  5. Final response is sent.

Code Example:

POST /messages/readreceipts:send
Content-Type: application/json

{
  "messageId": "6aa0938a-bd77-456b-90b3-11884e61f024",
  "channelRegistrationId": "ee527944-894b-4b58-8b45-b80dc68d6aa1",
  "typingIndicator": true
}

@mikekistler mikekistler added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label Aug 5, 2025
Copy link

github-actions bot commented Aug 22, 2025

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Comment generated by summarize-checks workflow run.

@glorialimicrosoft glorialimicrosoft force-pushed the gelli/readReceiptTypingIndicator branch from 40342a5 to 4a50b02 Compare August 22, 2025 18:57
@glorialimicrosoft glorialimicrosoft force-pushed the gelli/readReceiptTypingIndicator branch from 63685b4 to 92579ae Compare August 22, 2025 19:06
@glorialimicrosoft glorialimicrosoft added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Sep 3, 2025
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Sep 22, 2025
Copy link
Member

@CHILIU-MSFT CHILIU-MSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@glorialimicrosoft glorialimicrosoft merged commit 8b1307d into main Oct 1, 2025
40 checks passed
@glorialimicrosoft glorialimicrosoft deleted the gelli/readReceiptTypingIndicator branch October 1, 2025 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. data-plane DataPlane new-api-version PipelineBotTrigger PublishToCustomers Acknowledgement the changes will be published to Azure customers. TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[IC3 ACS Cross Platform Messaging ] REST API Review
7 participants