Get Message
plivo.get_message
ActionVoice & SMSconnection required
Calls the Plivo API with the connection's credentials.
Fetch one message's record, including its current delivery state.
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
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_uuid The identifier of the message to fetch, as returned by a send. | string | Yes | — | — | 5b40a428-bfc7-4daf-9d06-726c558bf3b8 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"message_uuid": "5b40a428-bfc7-4daf-9d06-726c558bf3b8"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
message_uuid Plivo's identifier for the message. | string | — |
from_number The number or sender id the message was sent from. | string | — |
to_number The number the message was addressed to. | string | — |
message_direction Either inbound or outbound. | string | — |
message_state Delivery state: queued, sent, delivered, failed and so on. | string | — |
message_type Either sms, mms or whatsapp. | string | — |
message_time When Plivo accepted the message, in the account timezone. | string | — |
units How many message segments Plivo billed for. | number | — |
total_amount What the message cost, as a decimal string. | string | — |
total_rate The per-unit rate applied, as a decimal string. | string | — |
error_code Plivo's error code when the message failed, else null. | string | — |
resource_uri The message's own path under the Plivo API. | string | — |
{
"error_code": "",
"from_number": "",
"message_direction": "",
"message_state": "",
"message_time": "",
"message_type": "",
"message_uuid": "",
"resource_uri": "",
"to_number": "",
"total_amount": "",
"total_rate": "",
"units": 0
}See Get Message 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.