Get Message
messagebird.get_message
ActionVoice & SMSconnection required
Calls the MessageBird API with the connection's credentials.
Read one message back by id, with the delivery status MessageBird currently holds for each recipient.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- MessageBird
- Secret shape
- the access key, or {"access_key": "…"}
- Config it needs
- originator, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
message_id The id MessageBird returned when the message was sent. | string | Yes | — | — | e8077d803532c0b5937c639b60216938 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"message_id": "e8077d803532c0b5937c639b60216938"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id MessageBird's identifier for the message. | string | — |
href URL of the message object on MessageBird. | string | — |
status One of accepted, scheduled, partial or failed, derived from the per-recipient counts. 'accepted' means MessageBird holds the message; delivery is confirmed later. | string | — |
partial True when some recipients failed and others did not. | boolean | — |
total_count How many recipients the message was addressed to. | number | — |
sent_count How many recipients MessageBird has sent to so far. | number | — |
delivered_count How many recipients have confirmed delivery. | number | — |
failed_count How many recipients failed or let the message expire. | number | — |
failed_recipients One entry per failed recipient with its status, status_reason and status_error_code, so a partial send is visible instead of hidden. | array | — |
message The message object exactly as MessageBird returned it. | object | — |
{
"delivered_count": 0,
"failed_count": 0,
"failed_recipients": [],
"href": "",
"id": "",
"message": {},
"partial": false,
"sent_count": 0,
"status": "",
"total_count": 0
}See Get Message run in a workflow.
In a technical demo we add the MessageBird connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.