Send Message
vonage.send_message
ActionVoice & SMSconnection required
Calls the Vonage API with the connection's credentials.
Send a message through the Vonage Messages API, which handles SMS and the chat channels behind one endpoint. The API accepts the message and answers with a message_uuid, so the output reports 'accepted' and the id to correlate the status webhook with, not a delivery confirmation.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Vonage
- Secret shape
- {"api_key": "…", "api_secret": "…"}
- Config it needs
- api_region, from_number
- Resolved by
- config.connection_id, else node.connection_id
Configuration
10 fields, 2 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 |
|---|---|---|---|---|---|
to The recipient. On the sms channel that is a phone number in E.164 format; on the other channels it is the recipient's id on that channel. | string | Yes | — | 1–50 characters | 447700900000 |
text The body of the message, up to 1000 characters. | string | Yes | — | ≤ 1000 characters | Your order has shipped. |
from_number The sender shown on the handset — a Vonage number, or an alphanumeric sender id where the destination country allows one. Overrides the connection's default sender. | string | No | — | — | Acme |
channel The Messages API channel to send over. 'sms' is the documented default; other channels the account has enabled are passed through as written. | string | No | sms | — | sms |
message_type The kind of payload being sent; 'text' is what the text field above carries. | string | No | text | — | text |
encoding_type How to encode an SMS body: text for GSM-7, unicode for non-Latin characters, auto to let Vonage decide. Vonage documents this for the sms channel only. | string | No | — | one of "text", "unicode", "auto" | — |
client_ref Your own reference for this message, echoed back on the status webhook. | string | No | — | ≤ 100 characters | — |
ttl How long, in seconds, delivery of the message will be attempted before it expires. | number | No | — | 20–604800 | — |
webhook_url A URL to receive the status webhooks for this message, overriding the application's own setting. | string | No | — | url format | — |
extra Extra top-level body keys merged into the request, for the channel-specific blocks the Messages API documents. | object | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"channel": "sms",
"from_number": "Acme",
"message_type": "text",
"text": "Your order has shipped.",
"to": "447700900000"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
message_uuid Vonage's id for the accepted message. | string | — |
workflow_id The failover workflow id, present only when the request used failover; empty otherwise. | string | — |
status Always 'accepted' — the Messages API has taken the message and reports delivery later on the status webhook. | string | — |
{
"message_uuid": "",
"status": "",
"workflow_id": ""
}See Send Message run in a workflow.
In a technical demo we add the Vonage connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.