Buscar números disponíveis
GET /v1/phone-lines/available lista os números fixos que podem ser comprados agora em um DDD brasileiro. É o primeiro passo de uma compra: o number de cada resultado é exatamente o que POST /v1/phone-lines recebe.
Requer uma chave com escopo de tenant. Com um token OAuth / MCP, só o Proprietário do workspace pode buscar (
phone_lines:purchase, a mesma permissão da compra) — caso contrário, 403 PERMISSION_DENIED.Endpoint
GET https://pilotstatus.com.br/v1/phone-lines/available?ddd=11
Parâmetros de query
string
obrigatório
O DDD com dois dígitos, sendo o primeiro de 1 a 9 (ex.:
11, 21, 31). Ausente ou malformado → 400 INVALID_AREA_CODE, e nenhuma chamada é feita à operadora.Exemplo
Campos da resposta
string
O DDD que você buscou, repetido na resposta.
integer
Quantos números a operadora informa como disponíveis neste DDD. Não presuma que é igual ao tamanho de
numbers.object[]
Os números retornados por esta busca. Sem paginação.
string
Dígitos E.164 sem o
+: 55 + DDD + 8 dígitos, ex.: 551148637200. Envie este valor para POST /v1/phone-lines.string
O mesmo número formatado para leitura humana:
(11) 4863-7200.Bom saber
- Buscar não é reservar. Um número listado pode ser comprado por outra pessoa antes que a sua compra chegue a ele; nesse caso, ele volta nos resultados da compra como
NUMBER_UNAVAILABLE— sem cobrança ou, quando a operadora já o tinha vendido fora da Pilot Status, com o preço estornado para a sua carteira. Busque de novo e escolha outro. - Toda busca chega à nossa operadora e consome uma cota de requisições compartilhada por toda a plataforma. Busque uma vez, mostre a lista e reutilize-a — não consulte este endpoint periodicamente. Quando a cota se esgota, o endpoint responde
503 SUPPLIER_UNAVAILABLE. - A verificação do titular não é necessária para buscar — só para comprar. Veja Visão geral → verificação do titular.