Monitoring Outgoing WhatsApp Messages

Prev Next

Rocket.Chat’s WhatsApp apps provide a convenient way to receive real-time updates on the status of your messages. Keeping track of the delivery status for outgoing WhatsApp messages is crucial for effective communication and customer engagement.

To start receiving these updates, go to the WhatsApp app that you are using and follow these steps:

  1. Go to the Settings tab and enter a value for the Message Status Endpoint URL. The app sends a request with the status payload to the specified URL each time your message statuses, such as when it is sent, delivered, and read.

  2. Enable Allow Quote Messages settings.

  3. You can choose to filter the message status updates you receive at the Message Status Endpoint URL based on the message type. Go to Filter Message Status settings and select from the following options:

    • All: Receive the status of all messages.

    • Regular Messages: Receive the status of regular messages only.

    • Template Messages: Receive the status of template messages only.

  4. Click Save Changes.

Always confirm that the Allow Quote Messages setting is enabled to receive the full information payload.

The table below highlights the payload format you will receive on the endpoint for status update:

Field Name

Type

Description

msgId

string or undefined

The message ID.

mobileNo

string

The recipient’s WhatsApp phone number.

MessageStatus

string

Status of the message - sent, delivered, read

  • sent: This is the status when the message is sent from the workspace.

  • delivered: This status is received when the message is sent to the recipient.

  • read: This status is received when the recipient has read the message.

If the recipient reads the message immediately upon receiving it, you may not get the delivered status. You can verify the status for any message using the message ID.

timestamp

string

Timestamp of request.

ErrorDetails

Optional Type: String or WhatsApp error format

Errors from template messages will be shown here.

type

string

The type of message. It can either be a template message or a regular message.

connectedWhatsAppNo

string

Your connected WhatsApp number from which you sent the message to the user.

message

string

The outgoing message content.

The following code snippet shows an example of the expected payload:

{
  "msgId": "wwhfiupncCHWrak.fjiejFNcs==",
  "mobileNo": "0112344566",
  "MessageStatus": "read",
  "timestamp": "1753428239",
  "ErrorDetails": null,
  "type": "Regular Messages",
  "connectedWhatsAppNo": "555195255555",
  "message": "Thank you for contacting us!"
}

By utilizing this functionality, you can gain valuable insights into the delivery and engagement of your WhatsApp communications, helping you optimize your messaging strategies and provide better customer experiences.