Get Balance
messagebird.get_balance
ActionVoice & SMSconnection required
Calls the MessageBird API with the connection's credentials.
Read the account's remaining credit, so a workflow can warn before a campaign runs the balance out. Postpaid accounts always report 0.
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
This node takes no configuration beyond its connection.
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
payment Whether the account is prepaid or postpaid. | string | — |
type The currency the amount is in, as a name or an ISO-4217 code. | string | — |
amount The credit remaining; always 0 on a postpaid account. | number | — |
{
"amount": 0,
"payment": "",
"type": ""
}See Get Balance 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.