Get Message Status
mocean.get_message_status
ActionVoice & SMSconnection required
Calls the Mocean API with the connection's credentials.
Look up the current delivery state of one sent message.
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
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 |
|---|---|---|---|---|---|
msgid The message id Mocean returned when the SMS was submitted. | string | Yes | — | — | cust20013050311050614001 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"msgid": "cust20013050311050614001"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
msgid The message the status belongs to. | string | — |
message_status Mocean's state code: 1 delivered, 2 failed, 3 expired, 4 pending, 5 not found. | string | — |
credit_deducted How much credit the message cost. | string | — |
{
"credit_deducted": "",
"message_status": "",
"msgid": ""
}See Get Message Status 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.