Comprar linhas
⚠️ Efeito colateral real: esta chamada cobra dinheiro — NÃO é uma simulação, inclusive pelo playground. Cada número custa o preço mensal cheio (R33,90paraworkspacesemBRL,US 33.90 em USD), descontado primeiro dos créditos da sua carteira e depois do seu cartão salvo, e vira uma linha telefônica do seu workspace, ACTIVE e com o primeiro mês pago. Não há proporcional nem link de checkout: sem créditos e sem cartão salvo, o item falha com PAYMENT_FAILED.
Compra de 1 a 10 números obtidos em GET /v1/phone-lines/available. Os números são independentes: cada um é cobrado e adquirido separadamente, na ordem em que você os enviou, e um que falha não desfaz os outros. Por isso a requisição responde 200 quando foi processada, com um resultado por número — um 200 não significa que você comprou alguma coisa; sempre leia results[i].ok. Um item que falhou traz code e um error bilíngue, mas nenhum status HTTP próprio:
code do item | O que aconteceu | Cobrado? |
|---|---|---|
REQUEST_ALREADY_PROCESSED | Esta Idempotency-Key já foi usada para este número na última hora — qualquer que tenha sido o resultado daquela tentativa. | Não por esta requisição. |
NUMBER_UNAVAILABLE | O número já pertence a uma linha (de qualquer workspace, inclusive o seu), está sendo comprado em outra requisição neste momento, ou a operadora não o tem mais. | Não — ou estornado para a carteira. |
PAYMENT_FAILED | Créditos mais cartão salvo não cobriram o preço, ou a cobrança no cartão não foi concluída. | Não — os créditos descontados foram devolvidos. |
PAYMENT_PROVIDER_ERROR | O processador do cartão não respondeu. O cartão pode ter sido cobrado. | Carteira: não. Cartão: confira a fatura. |
PURCHASE_NOT_COMPLETED | Cobrado e adquirido, mas não foi possível registrar a linha do nosso lado. | Estornado para a carteira. |
SUPPLIER_UNAVAILABLE | A operadora falhou ao adquirir o número. | Estornado para a carteira. |
Um estorno depois de uma cobrança sempre vai para a carteira, inclusive a parte paga com cartão.
Qualquer resposta diferente de 200 significa que nenhum número foi tentado, com uma exceção: um 500 (ou um timeout) pode vir depois que números anteriores já foram cobrados e comprados — repita a mesma requisição com a mesma Idempotency-Key e depois liste suas linhas com GET /v1/phone-lines.
Idempotência (header obrigatório). A chave é rastreada por número, durante uma hora: a mesma chave com o mesmo número não cobra nada e responde ok: false, REQUEST_ALREADY_PROCESSED — tanto se a primeira tentativa comprou o número quanto se ela falhou (uma repetição não devolve o resultado original). Para tentar de novo um número que falhou, use uma chave nova. Uma requisição recusada por inteiro (400/403) não registra nada, então pode ser reenviada com a mesma chave. A chave é restrita ao seu workspace. Se o cache de idempotência estiver indisponível, a proteção deixa de ser aplicada, para não bloquear as compras.
Verificação do titular antes. O titular da conta precisa ser verificado (por /v1/phone-lines/verification ou no painel): nunca iniciada ou não concluída → 403 VERIFICATION_REQUIRED; recusada → 403 VERIFICATION_REJECTED; em análise manual → segue, mas as linhas compradas durante a análise são devolvidas, com as cobranças estornadas para a carteira, se ela for recusada.
Permissões: com um token OAuth / MCP, só o Proprietário do workspace pode comprar (phone_lines:purchase) — caso contrário, 403 PERMISSION_DENIED.
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 POST \
--url https://pilotstatus.com.br/v1/phone-lines \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"numbers": [
"551148637200",
"551148637201"
]
}
'import requests
url = "https://pilotstatus.com.br/v1/phone-lines"
payload = { "numbers": ["551148637200", "551148637201"] }
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({numbers: ['551148637200', '551148637201']})
};
fetch('https://pilotstatus.com.br/v1/phone-lines', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'numbers' => [
'551148637200',
'551148637201'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/phone-lines"
payload := strings.NewReader("{\n \"numbers\": [\n \"551148637200\",\n \"551148637201\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/phone-lines")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"numbers\": [\n \"551148637200\",\n \"551148637201\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"numbers\": [\n \"551148637200\",\n \"551148637201\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"number": "551148637200",
"ok": true,
"lineId": "cmg5k2l1n0001pl8example9x"
},
{
"number": "551148637201",
"ok": false,
"code": "PAYMENT_FAILED",
"error": "The payment did not go through. Add balance or check your card. | O pagamento não foi concluído. Adicione saldo ou confira seu cartão."
}
]
}Idempotency-Key novo para cada compra e repita uma key só para tentar de novo a mesma compra. Veja Comprar linhas.Autorizações
Sua chave de API ps_
Cabeçalhos
Obrigatório. Qualquer string de até 255 caracteres sem caracteres de controle — um UUID por compra é a escolha comum. Rastreada por número durante uma hora, restrita ao seu workspace: uma nova tentativa com a mesma chave nunca cobra duas vezes pelo mesmo número (o item responde REQUEST_ALREADY_PROCESSED). Ausente, vazia ou só com espaços em branco → 400 IDEMPOTENCY_KEY_REQUIRED; longa demais ou com caractere de controle (incluindo tab) → 400 IDEMPOTENCY_KEY_INVALID. É um header, nunca um campo do corpo.
1 - 255Corpo
De 1 a 10 números distintos, cada um exatamente como GET /v1/phone-lines/available o devolveu em number: dígitos E.164 sem o + — 55, um DDD de dois dígitos começando por 1–9 e depois 8 dígitos (551148637200). Números de DDDs diferentes podem ir na mesma requisição. numbers é o único campo aceito: qualquer outro é recusado com 400 UNKNOWN_FIELDS (o requestId do painel não existe aqui).
1 - 10 elements^55[1-9][0-9][0-9]{8}$["551148637200", "551148637201"]
Resposta
Processada: um resultado por número, na ordem de envio. Leia results[i].ok — todos os itens podem ter falhado.
Uma entrada por número, na ordem de envio.
Show child attributes
Show child attributes
Esta página foi útil?
curl --request POST \
--url https://pilotstatus.com.br/v1/phone-lines \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"numbers": [
"551148637200",
"551148637201"
]
}
'import requests
url = "https://pilotstatus.com.br/v1/phone-lines"
payload = { "numbers": ["551148637200", "551148637201"] }
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({numbers: ['551148637200', '551148637201']})
};
fetch('https://pilotstatus.com.br/v1/phone-lines', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'numbers' => [
'551148637200',
'551148637201'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pilotstatus.com.br/v1/phone-lines"
payload := strings.NewReader("{\n \"numbers\": [\n \"551148637200\",\n \"551148637201\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/phone-lines")
.header("Idempotency-Key", "<idempotency-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"numbers\": [\n \"551148637200\",\n \"551148637201\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"numbers\": [\n \"551148637200\",\n \"551148637201\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"number": "551148637200",
"ok": true,
"lineId": "cmg5k2l1n0001pl8example9x"
},
{
"number": "551148637201",
"ok": false,
"code": "PAYMENT_FAILED",
"error": "The payment did not go through. Add balance or check your card. | O pagamento não foi concluído. Adicione saldo ou confira seu cartão."
}
]
}