List Messages
messagebird.list_messages
ActionVoice & SMSconnection required
Calls the MessageBird API with the connection's credentials.
List the account's message history, filtered by originator, recipient, direction, status, type, date range or a search term.
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
11 fields, none 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 |
|---|---|---|---|---|---|
originator Only messages sent from this originator. | string | No | — | — | — |
recipient Only messages addressed to this phone number. | string | No | — | — | — |
direction mt for messages you sent, mo for messages you received. | string | No | — | one of "mt", "mo" | — |
status Only messages currently in this delivery status. | string | No | — | one of "scheduled", "sent", "buffered", "delivered", "expired", "delivery_failed" | — |
message_type Only messages of this type: sms, binary or flash. | string | No | — | one of "sms", "binary", "flash" | — |
searchterm Only messages whose body contains this text. | string | No | — | — | — |
contact_id Only messages exchanged with this MessageBird contact. | string | No | — | — | — |
date_from RFC3339 timestamp; only messages created at or after it. | string | No | — | iso8601 format | — |
date_until RFC3339 timestamp; only messages created at or before it. | string | No | — | iso8601 format | — |
limit How many records to return in one page. MessageBird caps a page at 200. | number | No | — | 1–200 | — |
offset How many records to skip before this page, for paging through a long list. | number | No | — | ≥ 0 | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records on this page, exactly as MessageBird returned them. | array | — |
count How many records this page contains. | number | — |
total_count How many records match in total, across all pages. | number | — |
offset How many records were skipped before this page. | number | — |
limit The page size MessageBird applied. | number | — |
{
"count": 0,
"items": [],
"limit": 0,
"offset": 0,
"total_count": 0
}See List Messages 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.