Skip to main content

​
Cancelar uma linha telefônica

DELETE /v1/phone-lines/{id} cancela uma linha e responde com a linha como ela fica depois. O que acontece depende do status da linha.
Exige uma chave com escopo de tenant. Com um token OAuth / MCP, só o Proprietário do workspace pode cancelar (phone_lines:cancel) — caso contrário, 403 PERMISSION_DENIED.

​
Endpoint

DELETE https://pilotstatus.com.br/v1/phone-lines/{id} Sem corpo. {id} é o id da linha, não o número de telefone.

​
O que acontece, por status

Um número devolvido deixa de ser seu de vez: nada desfaz uma devolução, e não há garantia de que você consiga esse número de novo. A conta do WhatsApp ativada nele continua vinculada a esse número — quem alugá-lo em seguida pode pedir um código de verificação para ele. Cancelar uma linha em atraso faz isso na hora, sem período de carência.
Se a devolução da mesma linha em atraso já estiver em andamento — iniciada pela execução horária do faturamento ou pelo Escolher quais linhas manter do painel —, a chamada responde 200 com a linha como ela está, possivelmente ainda PAYMENT_PENDING ou SUSPENDED, e esse processo conclui a devolução. Leia a linha de novo para confirmar RETURNED. Mudou de ideia sobre uma linha ACTIVE? Desfazer um cancelamento agendado só é possível no painel, pelo Proprietário do workspace (Linhas → a linha → Desistir do cancelamento), enquanto a linha ainda estiver ACTIVE.

​
Exemplo

O corpo é o objeto linha.

​
Eventos

  • Uma linha cancelada no fim do período envia phone_line.canceled quando passa a CANCELED — normalmente em até cerca de uma hora depois de currentPeriodEnd; se a operadora não confirmar, uma nova tentativa é feita a cada execução horária.
  • Uma linha em atraso devolvida por esta chamada envia phone_line.returned na hora.
Veja Webhooks das linhas telefônicas.

​
Erros