Poll activation
One code request: its status and, once TRANSCRIBED, its code. Poll it after POST /v1/phone-lines/{id}/activations every few seconds — the status can only move after our next check of the line, about every 15 seconds.
Do not stop polling at the first status that is not WAITING. Keep polling while status is WAITING, or CAPTURED with failureReason: null (the call arrived and its code is being read — a failed transcription is retried from the stored recording, up to 3 attempts in all, so this can last a few minutes). TRANSCRIBED does not guarantee a code — check code (null with no_code_in_transcript when no 6-digit code was heard). TIMED_OUT is recorded at the first check after pollDeadline, up to about 15 seconds later; that check still reads the line one last time, so a request can also move from WAITING to CAPTURED just after its pollDeadline.
The recording is not in this answer: hasAudio: true says there is one, served by GET /v1/phone-lines/activations/{activationId}/audio. A request of another workspace answers 404 ACTIVATION_NOT_FOUND, the same as one that does not exist. Sent with Cache-Control: no-store: the code is a credential.
Requires a tenant-scoped key — a number-scoped key (or per-number OAuth grant) gets 403 NUMBER_SCOPE_NOT_ALLOWED. Permission phone_lines:read: with an OAuth / MCP token the user must be an Owner or Admin (403 PERMISSION_DENIED otherwise).
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
}
}Authorizations
Your ps_ API key
Path Parameters
The code request id (activation.id, returned by POST /v1/phone-lines/{id}/activations).
Response
The code request. Sent with Cache-Control: no-store.
Show child attributes
Show child attributes
Was this page helpful?
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
}
}