Skip to main content

Receiving read receipts (RRs)

Ahmed Boghdady
Updated

Receiving read receipts (RRs)

A read receipt (RR) is a packet of information that indicates that a subscriber has read your message. In Mobile API, RCS currently supports read receipts.

Webhook RR Events

You may configure RR webhooks similar to how delivery receipts can be configured. You may specify a different configuration for your read receipts or reuse the DLR webhook configuration if you prefer. If you decide to receive both DLRs and RRs on the same URL, a receipt_type field is returned in the receipt, which will inform you of the receipt type.

RR Payload from Mobile API

A RR payload supplied from our webhook callback will look like:

Copy 
{
  "gateway_ref": "1727268401846005014",
  "read_at": "230327132513",
  "gateway_name": "InfoBipApi",
  "mt_id": "6421994a500a54428af55384",
  "type": "RCS",
  "receipt_type": "read"
}

where:

  • gateway_ref (string, always returned): The message ID on the Gateway (Message Aggregator) used to send the request.

    This may be useful for debugging issues.

  • read_at (string, always returned): Date/time that the message was read.

    Returned in the format: %y%m%d%H%M%S (e.g. 2023-02-12 15:30:00 → "230212153000")

  • gateway_name (string, always returned): The name of the Gateway Mobile API used to send the request.

  • mt_id (string): The ID of the MT for this delivery receipt, as the id field in the response for sending a message.

  • type (string, always returned): The message type. It should always be RCS for read receipts.

  • receipt_type (string, always returned): The receipt type, which is expected to be read for read receipts. If you’ve configured RCS delivery and read receipts to be received on the same URL, you may use this field to differentiate between the two receipt types.