Axuz Developers

POST /api/sms/phones

Opt-in de um telefone e envio de OTP inline via Twilio.

  • 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`.

Valida E.164; rate limit 3/h/user; UPSERT em user_phones — reenviar pro mesmo número refresha OTP; se Twilio configurado envia inline (sem fila) — falha vira 502.

Parâmetros

Sem parâmetros.

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
phonestringsim

E.164 obrigatório (+ + 8-15 dígitos).

{
  "phone": "+15550001111"
}

Respostas

201

Telefone cadastrado (OTP enviado inline se Twilio configurado).

NomeTipoObrigatórioDescrição
idstring<uuid>sim
phonestringsim
verified_atstring<date-time> | nullnão
verification_expires_atstring<date-time> | nullnão
is_primarybooleansim
created_atstring<date-time>sim

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

429

Rate limit por user excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Falha inesperada no server.

NomeTipoObrigatórioDescrição
errorstringsim

502

Twilio recusou o envio.

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 POST 'https://messaging-api.axuz.net/api/sms/phones' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"phone":"+15550001111"}'

Node.js

const res = await fetch("https://messaging-api.axuz.net/api/sms/phones", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "phone": "+15550001111"
  }),
});
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(
    "POST",
    "https://messaging-api.axuz.net/api/sms/phones",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "phone": "+15550001111",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())