Passer au contenu principal
POST
Find numbers to claim

Autorisations

Authorization
string
header
requis

An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create.

En-têtes

LobbyStack-Business
string<uuid>

The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.

Corps

application/json
country
enum<string>

Defaults to the country of the business's time zone, or US. When the account the key acts as verified a mobile number for this business, that number's country decides. A deployment offers US and CA, and GB, AU and NZ once its carrier is set up for them.

Options disponibles:
US,
CA,
GB,
AU,
NZ
kind
enum<string>

Defaults to local. GB and AU numbers are always mobile, and NZ numbers local.

Options disponibles:
local,
mobile,
toll_free
area_code
string
Pattern: ^\d{1,6}$
city
string
Required string length: 1 - 100
region
string

A state or province, such as ON or NY.

Required string length: 1 - 64
postal_code
string
Required string length: 1 - 16
limit
integer

How many offers to return. Defaults to 10.

Plage requise: 1 <= x <= 20
replaces
string<uuid>

The id of an active number to replace. The offers are then replacements, which only POST /phone-numbers/{phone_number_id}/replace accepts.

Réponse

OK

data
object[]
requis
next_cursor
string | null
requis

Pass as cursor to get the next page. Null on the last page.

has_more
boolean
requis