List Numbers
plivo.list_numbers
ActionVoice & SMSconnection required
Calls the Plivo API with the connection's credentials.
List the phone numbers rented on the account, filtered and paged.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Plivo
- Secret shape
- {"username": "<Auth ID>", "password": "<Auth Token>"}
- Config it needs
- auth_id, src, answer_url, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, none 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 |
|---|---|---|---|---|---|
number_type Keep only numbers of this type, written exactly as Plivo names it. | string | No | — | — | — |
number_startswith Keep only numbers beginning with these digits, such as a country or area code. | string | No | — | — | — |
alias Keep only numbers carrying this alias. | string | No | — | — | — |
services Keep only numbers offering these services, as a comma-separated list of sms, voice and mms. | string | No | — | — | sms,voice |
subaccount Restrict the search to one subaccount, given as its auth ID. | string | No | — | — | — |
limit How many records to return in one page. Plivo caps a page at 20. | number | No | — | 1–20 | — |
offset How many records to skip before this page, for paging through a long list. | number | No | — | ≥ 0 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"services": "sms,voice"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records on this page, exactly as Plivo returned them. | array | — |
count How many records this page contains. | number | — |
total_count How many records match in total, across all pages. | number | — |
offset How many records were skipped before this page. | number | — |
limit The page size Plivo applied. | number | — |
next Relative URI of the next page, or null on the last page. | string | — |
previous Relative URI of the previous page, or null on the first. | string | — |
api_id Plivo's identifier for this API request. | string | — |
{
"api_id": "",
"count": 0,
"items": [],
"limit": 0,
"next": "",
"offset": 0,
"previous": "",
"total_count": 0
}See List Numbers run in a workflow.
In a technical demo we add the Plivo connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.