Axuz Developers

DELETE /api/sms/phones/{id}

Remove telefone; recusa se for primary e houver outros verificados.

  • Acesso: Login
  • Serviço: https://messaging-api.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

Remove um telefone; recusa deletar primary com outros verificados.

Motivo: forçar o usuário a promover outro primary antes evita ficar sem canal SMS silenciosamente. Comportamento: parse UUID; SELECT is_primary — 404 se não pertence; se is_primary e existem outros verified → 409 "promote_another_primary_first"; senão DELETE; 200 {"deleted": true}. NOTA: se is_primary sem outros verified permite deletar (user opta por sair do canal SMS).

Entradas: URLParam id.

Retorno: 200; 400/404/409/500.

Parâmetros

NomeEmTipoObrigatórioDescrição
idpathstringsim

Respostas

200

Deletado.

NomeTipoObrigatórioDescrição
deletedbooleansim

enum: true

400

Body inválido ou parâmetro fora do esperado.

NomeTipoObrigatórioDescrição
errorstringsim

401

Falta cookie/bearer ou X-Axuz-Internal.

NomeTipoObrigatórioDescrição
errorstringsim

404

Recurso não existe (ou não pertence ao user).

NomeTipoObrigatórioDescrição
errorstringsim

409

Number é primary com outros verificados — promova outro antes.

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X DELETE 'https://messaging-api.axuz.net/api/sms/phones/ID' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://messaging-api.axuz.net/api/sms/phones/ID", {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "DELETE",
    "https://messaging-api.axuz.net/api/sms/phones/ID",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())