Properties
| Name | Type | Description |
|---|---|---|
| messageId | string | The message's id in the Messaging Service |
The message's id in the Messaging Service | ||
| conversationCode | string | The code of the conversation it belongs to |
The code of the conversation it belongs to | ||
| externalAddress | string | The other party's number, E.164 |
The other party's number, E.164 | ||
| contact | CodeAndNameDto | |
| direction | enum | Inbound Outbound |
Inbound Outbound | ||
| channel | enum | Sms WhatsApp |
Sms WhatsApp | ||
| tenantAddress | string | The practice's own number on the message, E.164 |
The practice's own number on the message, E.164 | ||
| body | string | The text; empty for a media-only message |
The text; empty for a media-only message | ||
| contentSid | string | The WhatsApp template sent (HX…); null for free text and inbound messages |
The WhatsApp template sent (HX…); null for free text and inbound messages | ||
| template | CodeAndNameDto | |
| status | enum | Queued Sending Sent Delivered Read Undelivered Failed Received |
Queued Sending Sent Delivered Read Undelivered Failed Received | ||
| errorCode | integer | The provider's error code when it failed or was not delivered |
The provider's error code when it failed or was not delivered | ||
| errorMessage | string | The provider's error text when sending was refused |
The provider's error text when sending was refused | ||
| sentByUser | CodeAndNameDto | |
| messageDate | string | When the Messaging Service stored it (UTC) |
When the Messaging Service stored it (UTC) | ||
| media | array of MessagingMessageMediaDto | Its attachments |
Its attachments | ||
JSON Example
{
"messageId": "00000000-0000-0000-0000-000000000000",
"conversationCode": "string",
"externalAddress": "string",
"contact": {
"code": "string",
"name": "string"
},
"direction": "Inbound"
}