Documentación de la API de SMS para enviar desde tu propio código

Autenticación

Envía tu clave en el encabezado Authorization: Authorization: Bearer sso_live_.... Las claves tienen 49 caracteres y comienzan con sso_live_. Hasta 5 claves por cuenta; revoca una en el espacio de trabajo y dejará de funcionar de inmediato. La lista de precios es pública y no requiere clave.

Errores

Los errores usan códigos de estado HTTP y un cuerpo JSON con un código estable y una frase que puedes mostrar a una persona. No se cobra nada cuando falla una solicitud.

HTTP/1.1 402 Payment Required
{ "error": { "code": "insufficient_credit", "message": "Short by $3.20. Add funds to send.", "total": "8.62480", "credit": "5.42000" } }

Límites

• 240 solicitudes por minuto por clave, mostradas en X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset (segundos unix).
• 5,000 números por solicitud, 2,000 caracteres por texto, 10 segmentos por mensaje.
• Los mensajes se envían a un máximo de 300 por minuto por cuenta.
• send_at desde 10 minutos hasta 30 días adelante.

Precios

GET/api/v1/prices

GET/api/v1/prices/{country}

El precio por mensaje (un segmento) para cada país, en USD con 5 decimales. No se necesita clave.

{ "price": { "country": "GB", "name": "United Kingdom", "dial_code": "+44", "price_usd": "0.00868" }, "updated": "2026-11-07" }

Saldo de la cuenta

GET/api/v1/account

{ "account": "SO8K2M4Q7X9TBA", "credit_usd": "41.27660", "currency": "USD" }

Calcular el costo

POST/api/v1/costs

Toma el mismo cuerpo que un envío y devuelve el costo, sin enviar ni cobrar. El texto fusionado de cada destinatario decide sus segmentos, por lo que el total es exacto.

{
  "recipients": 2, "segments_min": 1, "segments_max": 1, "encoding": "gsm7", "messages_billed": 2,
  "total_usd": "0.01426", "credit_usd": "41.27660", "enough_credit": true,
  "countries": [ { "country": "GB", "recipients": 1, "price_usd": "0.00868", "subtotal_usd": "0.00868" },
                 { "country": "US", "recipients": 1, "price_usd": "0.00558", "subtotal_usd": "0.00558" } ],
  "dropped": [], "too_long": null
}

Crear un envío

POST/api/v1/sends

Un texto a uno o muchos números. El crédito para todo el envío se toma cuando se acepta; los mensajes fallidos se reembolsan uno por uno.

HTTP/1.1 201 Created
{
  "send": { "id": "CA7Q29XMAB4DFK", "status": "queued", "source": "api", "recipients": 2, "segments_max": 1,
            "encoding": "gsm7", "cost_usd": "0.01426", "refunded_usd": "0.00000", "client_ref": "bookings-1107",
            "send_at": null, "created_at": "2026-11-07T10:12:03.120Z", "started_at": null, "finished_at": null },
  "dropped": [ { "value": "+4412", "code": "too_short", "message": "Too short" } ]
}

Los números que no se pueden enviar se enumeran en dropped y nunca se cobran. Códigos: no_country_code, too_short, too_long, not_a_number, wrong_length, not_covered, duplicate y suppressed (en tu lista de no enviar).

Obtener o listar envíos

GET/api/v1/sends/{id}

GET/api/v1/sends?limit=25&before={id}

Un solo envío incluye counts por estado de mensaje. Las listas son las más nuevas primero; pasa next_before como before para la siguiente página. Los envíos desde el espacio de trabajo también aparecen aquí, con source: "web".

Mensajes

GET/api/v1/sends/{id}/messages?status=failed&limit=100

GET/api/v1/messages/{id}

{ "message": { "id": "MS3D8RW0K2QJ7N", "send_id": "CA7Q29XMAB4DFK", "to": "+447700900461", "country": "GB",
  "segments": 1, "price_usd": "0.00868", "status": "delivered", "reason": null, "reason_text": null,
  "created_at": "2026-11-07T10:12:03.120Z", "sent_at": "2026-11-07T10:12:04.010Z", "done_at": "2026-11-07T10:12:09.400Z" } }

Cancelar un envío

POST/api/v1/sends/{id}/cancel

Solo los envíos programados que no han comenzado pueden cancelarse. El costo total regresa a tu saldo y la respuesta incluye refunded_usd.

Webhooks

Establece una URL https en el espacio de trabajo (API y webhooks). Enviamos un evento POST cuando un mensaje se entrega o falla, tanto para envíos desde la API como desde el espacio de trabajo. Responde con cualquier estado 2xx dentro de 10 segundos. Los envíos fallidos se intentan nuevamente hasta 7 veces en total: inmediatamente, luego después de 1 minuto, 5 minutos, 30 minutos, 1 hora, 2 horas y 3 horas. El espacio de trabajo muestra cada intento con su estado y respuesta.

POST https://your-server.example/sms-events
X-SSO-Event: message.delivered
X-SSO-Delivery: evt_5a0c9e31d2b7f4a68c
X-SSO-Timestamp: 1794132729
X-SSO-Signature: sha256=8f1c...e42a

{ "id": "evt_5a0c9e31d2b7f4a68c", "event": "message.delivered", "created": "2026-11-07T10:12:09.000Z",
  "data": { "message": { "id": "MS3D8RW0K2QJ7N", "send_id": "CA7Q29XMAB4DFK", "to": "+447700900461", "country": "GB",
  "segments": 1, "price_usd": "0.00868", "status": "delivered", "reason": null, "reason_text": null,
  "client_ref": "bookings-1107", "created_at": "...", "sent_at": "...", "done_at": "..." } } }

La firma es HMAC-SHA256 de timestamp + "." + raw body con tu secreto de firma (comienza con sso_whk_). Verifícalo en el cuerpo sin procesar antes de analizar, rechaza marcas de tiempo mayores a 5 minutos y usa el id de entrega para ignorar repeticiones.

import crypto from "node:crypto";

// rawBody: the request body exactly as received (a string), before JSON.parse
export function verify(rawBody, headers, secret) {
  const ts = headers["x-sso-timestamp"];
  const sig = headers["x-sso-signature"] || "";
  const want = "sha256=" + crypto.createHmac("sha256", secret).update(`${ts}.${rawBody}`).digest("hex");
  const fresh = Math.abs(Date.now() / 1000 - Number(ts)) < 300;
  return fresh && sig.length === want.length && crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(want));
}

import hashlib, hmac, time

def verify(raw_body: bytes, headers, secret: str) -> bool:
    ts = headers.get("X-SSO-Timestamp", "")
    sig = headers.get("X-SSO-Signature", "")
    mac = hmac.new(secret.encode(), f"{ts}.".encode() + raw_body, hashlib.sha256)
    want = "sha256=" + mac.hexdigest()
    fresh = ts.isdigit() and abs(time.time() - int(ts)) < 300
    return fresh and hmac.compare_digest(sig, want)

<?php
function verify(string $rawBody, string $ts, string $sig, string $secret): bool {
  $want = "sha256=" . hash_hmac("sha256", $ts . "." . $rawBody, $secret);
  return ctype_digit($ts) && abs(time() - (int)$ts) < 300 && hash_equals($want, $sig);
}

Eventos: message.delivered, message.failed, y test desde el botón Enviar evento de prueba.

Estados y razones

Razones de fallo (el campo reason):