Buscar números disponíveis
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.
- 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. - 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.
Permissões: 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. Uma chave ps_ clássica de tenant não tem usuário nem papel: a autoridade dela é o escopo.
Todo endpoint /v1/phone-lines aceita só uma chave com escopo de tenant: a linha pertence ao workspace, não a um número de WhatsApp, então uma chave com escopo de número (ou uma concessão OAuth por número) recebe 403 NUMBER_SCOPE_NOT_ALLOWED antes de qualquer verificação de papel. Um 403 PERMISSION_DENIED / WORKSPACE_MEMBERSHIP_REQUIRED é enviado com Cache-Control: no-store.
Requer uma chave com escopo de tenant.
curl --request GET \
--url https://pilotstatus.com.br/v1/phone-lines/available \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines/available"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/phone-lines/available', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/phone-lines/available",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/phone-lines/available"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/phone-lines/available")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines/available")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"ddd": "11",
"totalAvailable": 2,
"numbers": [
{
"number": "551148637200",
"display": "(11) 4863-7200"
},
{
"number": "551148637201",
"display": "(11) 4863-7201"
}
],
"price": 33.9,
"currency": "BRL"
}Autorizações
Sua chave de API ps_
Parâmetros de consulta
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.
^[1-9][0-9]$Resposta
Números disponíveis no DDD
O DDD que você buscou, repetido na resposta.
"11"
Quantos números a operadora informa como disponíveis neste DDD. Não presuma que é igual ao tamanho de numbers.
2
Os números retornados por esta busca. Sem paginação.
Show child attributes
Show child attributes
Preço mensal de UMA linha nova para este workspace, mostrado antes da compra. Respeita o preço de linha próprio do workspace definido pela equipe da Pilot Status; é o mesmo valor que o POST /v1/phone-lines cobra.
33.9
A moeda do workspace — a moeda de price e da compra.
BRL, USD "BRL"
Esta página foi útil?
curl --request GET \
--url https://pilotstatus.com.br/v1/phone-lines/available \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines/available"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/phone-lines/available', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pilotstatus.com.br/v1/phone-lines/available",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/phone-lines/available"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/phone-lines/available")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines/available")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"ddd": "11",
"totalAvailable": 2,
"numbers": [
{
"number": "551148637200",
"display": "(11) 4863-7200"
},
{
"number": "551148637201",
"display": "(11) 4863-7201"
}
],
"price": 33.9,
"currency": "BRL"
}