Reference to the communication channel used to send this message, defining the medium and provider configuration

Example: "channel-uuid-here"

The type of message based on delivery medium

Values: email, sms, letter, whatsapp, push, in-app, voice

Example: "email"

Current delivery status of the message in its lifecycle

Values: draft, queued, sending, sent, delivered, read, failed, bounced, cancelled

Example: "delivered"

Information about the message sender, including name, address or phone number, and optional reply-to address

Example: {"name":"Acme Corp Support","address":"support@acme.com","replyTo":"noreply@acme.com"}

Reference to the person entity when the sender is a known person in the system

Reference to the organization entity when the sender is a known organization in the system

Reference to the person entity receiving this message, when the recipient is a known entity in the system

Example: "person-uuid-here"

Direct contact address for the recipient such as email address, phone number, or postal address when recipient entity is not available

Example: "john.doe@example.com"

Subject line or title of the message, primarily used for email and letter formats

Example: "Your order has been shipped"

The main body content of the message in plain text, HTML, or markdown format

Example: "Dear customer, your order #12345 has been shipped and will arrive within 3-5 business days."

Format specification for the message content

Values: text, html, markdown

Example: "text"

Reference to the message template used to generate this message content

Example: "template-uuid-here"

Key-value pairs of variables substituted into the template to generate the final message content

Example: {"customerName":"John Doe","orderNumber":"12345","deliveryDate":"2025-12-01"}

Array of file attachments included with the message, containing filename, content type, size, and storage reference

Example: [{"filename":"invoice.pdf","contentType":"application/pdf","size":45632,"url":"https://storage.example.com/attachments/invoice-123.pdf"}]

Delivery priority level affecting queue processing order and delivery urgency

Values: low, normal, high, urgent

Example: "normal"

Scheduled date and time for sending the message, allowing deferred delivery

Example: "2025-12-01T09:00:00Z"

Timestamp when the message was successfully sent to the delivery provider or channel

Example: "2025-11-27T14:30:00Z"

Timestamp when the message was confirmed as delivered to the recipient's device or mailbox

Example: "2025-11-27T14:31:15Z"

Timestamp when the recipient opened or read the message, if tracking is enabled and supported

Example: "2025-11-27T15:45:30Z"

Timestamp when the message delivery failed or bounced

Detailed explanation of why the message delivery failed, including error codes or provider responses

Reference to the message record in the external communication provider system for tracking and webhook correlation

Additional custom data associated with this message for integration, analytics, or business-specific tracking purposes

Example: {"campaignId":"summer-sale-2025","userId":"user-123","tags":["transactional","order-confirmation"]}

Indicates whether the message has been successfully delivered to the recipient

Example: true

Indicates whether the message delivery has permanently failed or bounced

Time elapsed in seconds between sending and delivery confirmation

Example: 75