Consultar ativação
Um pedido de código: o status e, quando estiver TRANSCRIBED, o code. Consulte-o depois de POST /v1/phone-lines/{id}/activations, a cada alguns segundos — o status só pode mudar depois da nossa próxima verificação da linha, feita a cada 15 segundos, aproximadamente.
Não pare de consultar no primeiro status diferente de WAITING. Continue consultando enquanto status for WAITING, ou CAPTURED com failureReason: null (a ligação chegou e o código está sendo lido — uma transcrição que falha é refeita a partir da gravação armazenada, até 3 tentativas no total, então isso pode levar alguns minutos). TRANSCRIBED não garante um código — verifique code (null com no_code_in_transcript quando nenhum código de 6 dígitos foi ouvido). TIMED_OUT é registrado na primeira verificação depois de pollDeadline, até cerca de 15 segundos depois; essa verificação ainda lê a linha uma última vez, então um pedido também pode passar de WAITING para CAPTURED logo depois do seu pollDeadline.
A gravação não vem nesta resposta: hasAudio: true indica que existe uma, servida por GET /v1/phone-lines/activations/{activationId}/audio. Um pedido de outro workspace responde 404 ACTIVATION_NOT_FOUND, da mesma forma que um pedido que não existe. 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).
curl --request GET \
--url https://pilotstatus.com.br/v1/phone-lines/activations/{activationId} \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines/activations/{activationId}"
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/activations/{activationId}', 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/activations/{activationId}",
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/activations/{activationId}"
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/activations/{activationId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines/activations/{activationId}")
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{
"activation": {
"id": "cmg5k3a7c0002ac8example4q",
"lineId": "cmg5k2l1n0001pl8example9x",
"status": "TRANSCRIBED",
"requestedAt": "2026-10-01T14:10:00.000Z",
"pollDeadline": "2026-10-01T14:15:00.000Z",
"code": "123456",
"capturedAt": "2026-10-01T14:11:42.000Z",
"transcribedAt": "2026-10-01T14:11:51.000Z",
"failureReason": null,
"hasAudio": true
}
}Autorizações
Sua chave de API ps_
Parâmetros de caminho
O id do pedido de código (activation.id, retornado por POST /v1/phone-lines/{id}/activations).
Resposta
O pedido de código. Enviado com Cache-Control: no-store.
Show child attributes
Show child attributes
Esta página foi útil?
curl --request GET \
--url https://pilotstatus.com.br/v1/phone-lines/activations/{activationId} \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines/activations/{activationId}"
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/activations/{activationId}', 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/activations/{activationId}",
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/activations/{activationId}"
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/activations/{activationId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines/activations/{activationId}")
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{
"activation": {
"id": "cmg5k3a7c0002ac8example4q",
"lineId": "cmg5k2l1n0001pl8example9x",
"status": "TRANSCRIBED",
"requestedAt": "2026-10-01T14:10:00.000Z",
"pollDeadline": "2026-10-01T14:15:00.000Z",
"code": "123456",
"capturedAt": "2026-10-01T14:11:42.000Z",
"transcribedAt": "2026-10-01T14:11:51.000Z",
"failureReason": null,
"hasAudio": true
}
}