get_message
Fetch a message by ID to check whether and how a recipient was notified: delivery status and reason, channel used, rendered content, and engagement. Use it after sending or with an event message ID.
Instructions
Fetch one message by id to learn whether and how a person was notified: delivery status and its reason, the channel used, the rendered content and engagement. Use it after send_message, or with a message_id from get_event; use list_messages when you have no id. Needs the messages:read scope.
Returns id, status (queued, sending, pending_approval, sent, delivered, failed, suppressed or cancelled), status_reason (why it was suppressed, failed, held or cancelled, e.g. frequency_cap: 3 per 1 day, 0:00:00 or agent_budget: …; null otherwise), category, template, channels (planned, in fallback order), channel (the one used), locale, content (rendered title, body, url… under default and each channel with its own override), importance, agent, event_id, rule_id, reviewed_by, reviewed_at, screening, attempts, send_at, expires_at, sent_at, delivered_at, opened_at, clicked_at, converted_at and created_at. Fails with 404 when the id does not exist or, for an agent key, belongs to another sender.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message_id | Yes | Message UUID: the `id` returned by send_message or list_messages, or a `message_id` in get_event's `outcome`. |