Linhas telefônicas
Listar webhooks das linhas
Retorna { "webhooks": [ … ], "events": [ … ] }: todos os webhooks das linhas do seu workspace, do mais antigo para o mais novo, e o catálogo de eventos que você pode assinar. O segredo de assinatura nunca é devolvido aqui — só uma vez, por POST /v1/phone-lines/webhooks.
Permissões: com um token OAuth / MCP, o usuário precisa ser Proprietário ou Administrador (phone_lines:webhooks) — caso contrário, 403 PERMISSION_DENIED.
Todo endpoint /v1/phone-lines aceita só uma chave com escopo de tenant: os webhooks das linhas pertencem 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.
Estes são os webhooks das linhas — um cadastro separado de /v1/webhooks: recebem só eventos phone_line.*, e um webhook de número nunca recebe um deles.
Requer uma chave com escopo de tenant.
GET
/
v1
/
phone-lines
/
webhooks
Listar webhooks das linhas
curl --request GET \
--url https://pilotstatus.com.br/v1/phone-lines/webhooks \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines/webhooks"
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/webhooks', 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/webhooks",
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/webhooks"
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/webhooks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines/webhooks")
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{
"webhooks": [
{
"id": "cmh1w8b2k0001wh8example3d",
"name": "hooks.example.com",
"url": "https://hooks.example.com/pilot/phone-lines",
"events": [
"*"
],
"active": true,
"lastDeliveryAt": "2026-10-27T14:11:51.000Z",
"lastStatusCode": 200,
"createdAt": "2026-10-27T13:58:02.000Z"
}
],
"events": [
"phone_line.purchased",
"phone_line.audio_received",
"phone_line.code_received",
"phone_line.code_failed",
"phone_line.renewed",
"phone_line.payment_failed",
"phone_line.suspended",
"phone_line.returned",
"phone_line.canceled",
"phone_line.verification_updated"
]
}Autorizações
apiKeyapiKeyId
Sua chave de API ps_
Resposta
Os webhooks e o catálogo de eventos
Show child attributes
Show child attributes
Todos os nomes de eventos de linha. "*" não está na lista, mas é aceito em events.
Exemplo:
[
"phone_line.purchased",
"phone_line.audio_received",
"phone_line.code_received",
"phone_line.code_failed",
"phone_line.renewed",
"phone_line.payment_failed",
"phone_line.suspended",
"phone_line.returned",
"phone_line.canceled",
"phone_line.verification_updated"
]
Esta página foi útil?
⌘I
Listar webhooks das linhas
curl --request GET \
--url https://pilotstatus.com.br/v1/phone-lines/webhooks \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines/webhooks"
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/webhooks', 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/webhooks",
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/webhooks"
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/webhooks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines/webhooks")
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{
"webhooks": [
{
"id": "cmh1w8b2k0001wh8example3d",
"name": "hooks.example.com",
"url": "https://hooks.example.com/pilot/phone-lines",
"events": [
"*"
],
"active": true,
"lastDeliveryAt": "2026-10-27T14:11:51.000Z",
"lastStatusCode": 200,
"createdAt": "2026-10-27T13:58:02.000Z"
}
],
"events": [
"phone_line.purchased",
"phone_line.audio_received",
"phone_line.code_received",
"phone_line.code_failed",
"phone_line.renewed",
"phone_line.payment_failed",
"phone_line.suspended",
"phone_line.returned",
"phone_line.canceled",
"phone_line.verification_updated"
]
}