The message object

Returned by GET /v1/messages/{id}. Fields with no value are left out.

Fields

Field	Type	Description
`id`	string (UUID)	Hello’s message ID. The same ID as `messages[0].id` on the send response.
`account_id`	string (UUID)	The WhatsApp number the message was sent from
`message_id`	string	WhatsApp’s message ID (`wamid.…`). Empty while `queued`.
`conversation_id`	string	The conversation the message belongs to. Defaults to the recipient’s number.
`direction`	string	`outbound` for messages you send
`message_type`	string	`template`, `text`, `image`, `video`, `audio`, `document`, `sticker`, `location`, `contacts`, `interactive` or `reaction`
`recipient_phone`	string	Recipient’s number, normalised to digits
`sender_phone`	string	Your sending number
`template_name`	string	Template name, for template messages
`content`	object	What was sent. Its shape depends on `message_type`, mirroring the request.
`components`	array	Template header and body parameters that were sent
`status`	string	See status lifecycle
`error_code`	string	WhatsApp’s error code, when `status` is `failed`
`error_message`	string	Human-readable failure reason, when `status` is `failed`
`conversation_category`	string	WhatsApp’s pricing category for the conversation, for example `marketing`, `utility`, `authentication`, `service`
`pricing_type`	string	WhatsApp pricing type reported for the message
`sent_at`	timestamp	When WhatsApp accepted the message
`delivered_at`	timestamp	When it reached the recipient’s device
`read_at`	timestamp	When the recipient read it (only if read receipts are on)
`played_at`	timestamp	When the recipient played a voice message
`created_at`	timestamp	When Hello accepted the request

Timestamps are RFC 3339 in UTC.

Status lifecycle

queued ──► sent ──► delivered ──► read
   │         │          │
   └─────────┴──────────┴──► failed

Status	Meaning
`queued`	Accepted by Hello and waiting to go to WhatsApp
`sent`	Accepted by WhatsApp
`delivered`	Delivered to the recipient’s phone
`read`	Opened by the recipient
`failed`	Couldn’t be delivered. Check `error_code` and `error_message`.

Statuses only move forward. delivered can be final: recipients with read receipts off never produce read.