Documentation
Sign inGet started

bird numbers available list

Usage

Przykład kodu
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

Przykład kodu
bird numbers available list
bird numbers available list | jq -r '.data[].id'
bird numbers available list --limit 50 --starting-after <cursor>

Options

Filters

NameDescription
--capabilities <v1,v2,…>Filter by channel 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-codeISO 3166-1 alpha-2 country code to search in.
--number-typeReturn 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).
--prefixReturn 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-schemaPrint the fields this command returns, then exit

Pagination

NameDescription
--ending-beforeCursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
--limit <n>Maximum number of items to return per page.
--starting-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
NameDescription
bird numbers available getGet an available phone number