Back

POST api/v1/Receipt/MessageStatus

Requires Authorization

Get message status.This API endpoint will return details like TrackingId, sender, recipient, status of delivery for all the messages within a given date range or a message identified by the tracking id. The maximum allowed date range is only 24 hours.
TrackingId is optional but if tracking id is passed, date range will be ignored.

Request Information

URI Parameters

None.

Body Parameters

ReceiptMessageBindingModel

Name	Description	Type	Additional information
StartDate	Start date time	date	None.
EndDate	End date time	date	None.
TrackingId	Message tracking id. Message tracking id can be found in the acknowledgement email.	string	None.

Sample Request

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2024-11-21T10:15:32.1238364+00:00",
  "EndDate": "2024-11-21T10:15:32.1238364+00:00",
  "TrackingId": "sample string 1"
}

Response Information

Resource Description

Collection of ReceiptMessageDetailsModel

Name	Description	Type	Additional information
TrackingId	Message date	string	None.
CustomerTrackingId	Customer tracking id as sent in the message header X-RPost-CustomerTrackingId	string	None.
SenderName	Sender Name	string	None.
SenderAddress	Sender Address	string	None.
Date	Date message received	date	None.
Status	Message completion status - if all opened status will be 'All Delivered And Opened'	string	None.
Recipients	Message recipients	Collection of ReceiptRecipientData	None.
RedactedTextViewDetail	Redact Viewing Details	RedactedTextViewDetail	None.

Sample Response

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.