Cancel Number
vonage.cancel_number
ActionVoice & SMSconnection required
Calls the Vonage API with the connection's credentials.
Give a rented number back to Vonage, ending the rental. Vonage answers with a status envelope, so a refusal is surfaced as a failed step with its code and label.
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
3 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 |
|---|---|---|---|---|---|
country Two-letter ISO country code, for example GB or US. | string | Yes | — | 2–2 characters | GB |
msisdn The number the operation applies to, in E.164 format without a leading plus. | string | Yes | — | — | 447700900000 |
target_api_key Cancel the number held by this sub-account instead of the account the connection authenticates as. | string | No | — | credential material | credential |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"country": "GB",
"msisdn": "447700900000"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
error_code Vonage's status code for the operation; '200' is success. | string | — |
error_code_label The human-readable label for that status code. | string | — |
country The two-letter country code the operation applied to. | string | — |
msisdn The number the operation applied to. | string | — |
{
"country": "",
"error_code": "",
"error_code_label": "",
"msisdn": ""
}See Cancel Number 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.