Message
A SMS/MMS Message to or from a Contact
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
direction | string | incoming or outgoing, depending on if it was sent to or from the Contact | |||||||||
body | string | The body text of the message | |||||||||
formattedBody | string | The formatted body of the message | |||||||||
displayTimestamp | DateTime | When the message was sent or received | |||||||||
timelinePosition | DateTime | Sortable field inticating the order in the timeline in which messages should appear | |||||||||
deliveryState | string | The current state of the message.
| |||||||||
friendlyStateDescription | string | User-friendly description of the delivery state | |||||||||
source | string | Where a message originated from. | |||||||||
retryAllowed | boolean | If a failed message can be retried | |||||||||
flags | array | Additional info about the type of message. May include “automated”, “scheduled”, etc… | |||||||||
retry | Link | Retry sending this message if it failed | |||||||||
attachments | hydra:Collection | ||||||||||
latestEventAt | DateTime | Timestamp of the messages’ most-recent event | |||||||||
conversation | Link | ||||||||||
sender | User | The user that sent the message (outgoing messages only) | |||||||||
status | string |
|