Retrieve Message Fields Reference
Read about the messages fields that are returned when you retrieve a message.
The response body for the Retrieve a Message request is split into 3 sections:
MESSAGERAWRESPONSE: The raw response data.STATUSRESPONSE: The status information.MESSAGEDETAILSRESPONSE: The message details.
MESSAGERAWRESPONSE
| Field | Details | Description |
|---|---|---|
message | String | Message content, specified in Base64 format. |
messageInfo | Object | This contains the fields listed in the Message Details Fields Reference topic. |
STATUSRESPONSE
| Field | Details | Description |
|---|---|---|
error | Object | This object contains the fields listed in the Error Fields Reference topic. |
lastChanged | Date-Time | Timestamp of the message's last update, specified in ISO 8601 format. |
messageId | UUID | ID of the message. |
receivedAt | Date-Time | Timestamp of the message's receipt, specified in ISO 8601 format. |
status | Sting/Enumeration | Status of the message. The possible values are: HANDLED, TRANSMITTED, TRANSIENT ERROR, RETAINED, and PROCESSING. More details are provided in the Status Fields Reference topic. |
MESSAGEDETAILSRESPONSE
| Field | Details | Description |
|---|---|---|
acknowledgment | String | Confirmation of the message, specified in Base64 format. |
error | Object | This object contains the fields listed in the Error Fields Reference topic. |
externalReferences | Object | References to an external party such as a government. |
history | Array | Status history of the message. |
history.message | String | Message body at the time the historical record was created. |
history.status | String/Enumeration | Status at the time the historical record was created. More details are provided in the Status Fields Reference topic. |
history.timestamp | Date-Time | Timestamp of the historical record, specified in ISO 8601 format. |
messageInfo | Object | Metadata for a message. More details are provided in the Message Details Fields Reference topic. |
Updated about 18 hours ago