Get Account Balance
mocean.get_balance
ActionVoice & SMSconnection required
Calls the Mocean API with the connection's credentials.
Read the credit remaining on the Mocean account.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Mocean
- Secret shape
- {"api_token": "…"} — a Mocean API token, or {"api_key": "…", "api_secret": "…"}
- Config it needs
- base_url, sender_id, brand
- 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 |
|---|---|---|
value The remaining balance, in the account's currency. | number | — |
status Mocean's status code, '0' on a successful read. | string | — |
{
"status": "",
"value": 0
}See Get Account Balance run in a workflow.
In a technical demo we add the Mocean connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.