bird numbers available list
Usage
Code example
bird numbers available list [flags]Description
Searches one country's numbers on sale. Our own inventory answers first and pages; the last page can carry a live carrier snapshot, so a number seen here may be gone by the time it is ordered.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Procedure
Step 1 of 5 of "Buy a phone number". Next: bird numbers available get.
Examples
Code example
bird numbers available list
bird numbers available list | jq -r '.data[].number'
bird numbers available list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| --capabilities <value>… | Filter by capability. Repeat the parameter to require several at once: capabilities=sms&capabilities=voice returns only numbers that support both. Known values: sms, voice (others may exist). |
| --country-code | ISO 3166-1 alpha-2 country code to search in. (required) |
| --number-type | Return only numbers of this physical type after applying the country and prefix filters. Known values: mobile, local, national, short_code, short_code_fteu, toll_free (others may exist). |
| --prefix | Return only numbers that start with these digits, matched right after the country dial code: with country_code=US, prefix=212 matches +1 212 area-code numbers and prefix=833 matches 833 toll-free numbers. Digits only. Leave out the country dial code and any national dialing prefix such as a leading 0. Short codes never match a prefix search. |
| --response-schema | Print the fields this command returns, then exit |
Pagination
| Name | Description |
|---|---|
| --ending-before | Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since. |
| --limit <n> | Maximum number of items to return per page. |
| --starting-after | Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order. |
Related
| Name | Description |
|---|---|
| bird numbers available get | Get an available phone number |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Understand the conceptWhat is a virtual phone number (VMN)?Explore the capabilitySMS numbersImplementation guideNumber types
Get an implementation brief