List Messages
plivo.list_messages
ActionVoice & SMSconnection required
Calls the Plivo API with the connection's credentials.
Search the message log by direction, state, type, number or time, and page through the matches.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Plivo
- Secret shape
- {"username": "<Auth ID>", "password": "<Auth Token>"}
- Config it needs
- auth_id, src, answer_url, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
13 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 |
|---|---|---|---|---|---|
message_direction Keep only messages you sent (outbound) or received (inbound). | string | No | — | one of "inbound", "outbound" | — |
message_state Keep only messages in one delivery state. | string | No | — | one of "queued", "sent", "failed", "delivered", "undelivered", "rejected", "read" | — |
message_type Keep only messages sent on one channel. | string | No | — | one of "sms", "mms", "whatsapp" | — |
from_number Keep only messages sent from this number. | string | No | — | — | — |
to_number Keep only messages addressed to this number. | string | No | — | — | — |
message_time Keep only messages accepted at exactly this time, as YYYY-MM-DD or YYYY-MM-DD HH:MM. | string | No | — | — | — |
message_time_gte Keep only messages accepted at or after this time. | string | No | — | — | — |
message_time_lte Keep only messages accepted at or before this time. | string | No | — | — | — |
error_code Keep only messages that failed with this Plivo error code. | string | No | — | — | — |
powerpack_id Keep only messages sent through this Powerpack. | string | No | — | — | — |
subaccount Restrict the search to one subaccount, given as its auth ID. | string | No | — | — | — |
limit How many records to return in one page. Plivo caps a page at 20. | number | No | — | 1–20 | — |
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 Plivo 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 Plivo applied. | number | — |
next Relative URI of the next page, or null on the last page. | string | — |
previous Relative URI of the previous page, or null on the first. | string | — |
api_id Plivo's identifier for this API request. | string | — |
{
"api_id": "",
"count": 0,
"items": [],
"limit": 0,
"next": "",
"offset": 0,
"previous": "",
"total_count": 0
}See List Messages run in a workflow.
In a technical demo we add the Plivo connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.