Search Available Numbers
vonage.search_numbers
ActionVoice & SMSconnection required
Calls the Vonage API with the connection's credentials.
Search the numbers Vonage has available to rent in one country, with their type, features and price, ready to hand to the buy operation.
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
7 fields, 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 |
|---|---|---|---|---|---|
country Two-letter ISO country code, for example GB or US. | string | Yes | — | 2–2 characters | GB |
number_type Restrict the search to one kind of number. | string | No | — | one of "landline", "mobile-lvn", "landline-toll-free" | — |
pattern The digits to match anywhere in the number, used with search_pattern. | string | No | — | — | 1415 |
search_pattern How 'pattern' is matched: 0 starts with, 1 contains, 2 ends with. | number | No | — | 0–2 | — |
features Only return numbers with all of these capabilities, as a comma-separated list of SMS, VOICE and MMS. | string | No | — | — | SMS,VOICE |
size How many records to return on one page. Vonage caps a page at 100 and returns 10 when this is left blank. | number | No | — | 1–100 | — |
index Which page of results to return; Vonage numbers pages from 1. | number | No | — | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"country": "GB",
"features": "SMS,VOICE",
"pattern": "1415"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
numbers The number records on this page, exactly as Vonage returned them. | array | — |
count How many numbers match the search in total. | number | — |
{
"count": 0,
"numbers": []
}See Search Available Numbers 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.