Cancelar espera de ativação
Encerra um pedido de código que ainda está em WAITING — sem corpo —, para que o próximo POST /v1/phone-lines/{id}/activations seja aceito na hora, em vez de responder 409 ACTIVATION_IN_PROGRESS até a janela fechar.
Responde 200 com o pedido, agora TIMED_OUT com failureReason: "canceled_by_customer", enviado com Cache-Control: no-store. A linha deixa de ser monitorada para esse pedido. Como todo pedido que termina sem código, ele envia phone_line.code_failed e phone_line.code_received (com code: null) uma vez, com canceled_by_customer.
Uma ligação que já chegou nunca é descartada. Depois que a ligação é capturada, o pedido não está mais em WAITING, e o cancelamento responde 409 ACTIVATION_NOT_WAITING — continue consultando: o código dele está sendo lido. O mesmo 409 responde a um pedido que já terminou. Nada muda em nenhum dos casos. {id} precisa ser a linha à qual o pedido pertence: uma linha que não é do seu workspace responde 404 LINE_NOT_FOUND; um pedido que não é dessa linha — ou não é do seu workspace — responde 404 ACTIVATION_NOT_FOUND.
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 POST \
--url https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel', 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/{activationId}/cancel",
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/{activationId}/cancel"
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))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel")
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": "TIMED_OUT",
"requestedAt": "2026-10-01T14:10:00.000Z",
"pollDeadline": "2026-10-01T14:15:00.000Z",
"code": null,
"capturedAt": null,
"transcribedAt": null,
"failureReason": "canceled_by_customer",
"hasAudio": false
}
}Autorizações
Sua chave de API ps_
Parâmetros de caminho
A linha à qual o pedido pertence. Um pedido que não é dessa linha responde 404 ACTIVATION_NOT_FOUND.
O id do pedido de código (activation.id, retornado por POST /v1/phone-lines/{id}/activations).
Resposta
Espera cancelada — o pedido agora está TIMED_OUT com canceled_by_customer. Enviado com Cache-Control: no-store.
Show child attributes
Show child attributes
Esta página foi útil?
curl --request POST \
--url https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel', 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/{activationId}/cancel",
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/{activationId}/cancel"
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))
}HttpResponse<String> response = Unirest.post("https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines/{id}/activations/{activationId}/cancel")
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": "TIMED_OUT",
"requestedAt": "2026-10-01T14:10:00.000Z",
"pollDeadline": "2026-10-01T14:15:00.000Z",
"code": null,
"capturedAt": null,
"transcribedAt": null,
"failureReason": "canceled_by_customer",
"hasAudio": false
}
}