Linhas telefônicas

Solicitar código de ativação

Prepara a linha para capturar uma NOVA ligação de verificação do WhatsApp — sem corpo. O WhatsApp verifica um número fixo ligando para ele e falando um código de 6 dígitos; este endpoint abre a janela de captura, ele não faz a ligação. A linha é reiniciada na operadora, para que a gravação de uma ligação anterior nunca possa ser lida como o código deste pedido, e o pedido abre em WAITING até pollDeadline — 5 minutos depois. Uma ligação que chegar antes de este pedido existir não é capturada.

Depois do 201, registre o número no WhatsApp Business e escolha a opção de receber o código por ligação (“Call me” no app em inglês) — a linha é um número fixo e não recebe SMS. Então consulte GET /v1/phone-lines/activations/{activationId} a cada alguns segundos (ou aguarde o webhook phone_line.code_received) e digite o code no WhatsApp.

Permitido enquanto a linha está ACTIVE ou PAYMENT_PENDING; uma linha SUSPENDED, RETURNED ou CANCELED recebe 409 LINE_NOT_ACTIVE. Um pedido em espera por linha: enquanto um pedido estiver em WAITING e seu pollDeadline ainda não tiver passado, outro POST responde 409 ACTIVATION_IN_PROGRESS — consulte o pedido que você já tem, ou cancele-o com POST /v1/phone-lines/{id}/activations/{activationId}/cancel para pedir de novo na hora. Sem limite de pedidos ao longo do tempo; cada pedido aberto incrementa o activationCount da linha. Enviado com Cache-Control: no-store: o código é uma credencial.

Exige uma chave com escopo de tenant — uma chave com escopo de número (ou concessão OAuth por número) recebe 403 NUMBER_SCOPE_NOT_ALLOWED. Permissão phone_lines:read: com um token OAuth / MCP, o usuário precisa ser Proprietário ou Administrador (caso contrário, 403 PERMISSION_DENIED).

POST

phone-lines

{id}

activations

Solicitar um código de ativação

curl --request POST \
  --url https://pilotstatus.com.br/v1/phone-lines/{id}/activations \
  --header 'x-api-key: <api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/phone-lines/{id}/activations', 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/{id}/activations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/{id}/activations"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/phone-lines/{id}/activations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "activation": {
    "id": "cmg5k3a7c0002ac8example4q",
    "lineId": "cmg5k2l1n0001pl8example9x",
    "status": "WAITING",
    "requestedAt": "2026-10-01T14:10:00.000Z",
    "pollDeadline": "2026-10-01T14:15:00.000Z",
    "code": null,
    "capturedAt": null,
    "transcribedAt": null,
    "failureReason": null,
    "hasAudio": false
  }
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Parâmetros de caminho

string

obrigatório

O id da linha (de GET /v1/phone-lines) — não o número de telefone.

Resposta

Pedido de código aberto (WAITING). Enviado com Cache-Control: no-store.

activation

object

obrigatório

Show child attributes

Solicitar um código de ativação

curl --request POST \
  --url https://pilotstatus.com.br/v1/phone-lines/{id}/activations \
  --header 'x-api-key: <api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/phone-lines/{id}/activations', 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/{id}/activations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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/{id}/activations"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/phone-lines/{id}/activations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "activation": {
    "id": "cmg5k3a7c0002ac8example4q",
    "lineId": "cmg5k2l1n0001pl8example9x",
    "status": "WAITING",
    "requestedAt": "2026-10-01T14:10:00.000Z",
    "pollDeadline": "2026-10-01T14:15:00.000Z",
    "code": null,
    "capturedAt": null,
    "transcribedAt": null,
    "failureReason": null,
    "hasAudio": false
  }
}

Endpoints

Workspace

Solicitar código de ativação

Autorizações

Parâmetros de caminho

Resposta