Documentação da API de SMS para envio a partir do seu próprio código

Autenticação

Envie sua chave no cabeçalho Authorization: Authorization: Bearer sso_live_.... As chaves têm 49 caracteres e começam com sso_live_. Até 5 chaves por conta; revogue uma no espaço de trabalho e ela para de funcionar imediatamente. A lista de preços é pública e não precisa de chave.

Erros

Os erros usam códigos de status HTTP e um corpo JSON com um código estável e uma frase que você pode mostrar a uma pessoa. Nada é cobrado quando uma solicitação falha.

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" } }

Limites

• 240 solicitações por minuto por chave, mostradas em X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset (segundos unix).
• 5,000 números por solicitação, 2,000 caracteres por texto, 10 segmentos por mensagem.
• As mensagens são enviadas a até 300 por minuto por conta.
• send_at de 10 minutos a 30 dias à frente.

Preços

GET/api/v1/prices

GET/api/v1/prices/{country}

O preço por mensagem (um segmento) para cada país, em USD com 5 decimais. Nenhuma chave necessária.

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

Saldo da conta

GET/api/v1/account

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

Estimar um custo

POST/api/v1/costs

Recebe o mesmo corpo de um envio e retorna o custo, sem enviar ou cobrar. O texto mesclado de cada destinatário decide seus segmentos, então o total é exato.

{
  "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
}

Criar um envio

POST/api/v1/sends

Um texto para um ou vários números. O crédito para todo o envio é debitado quando ele é aceito; mensagens falhas são reembolsadas uma por uma.

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" } ]
}

Números que não podem ser enviados são listados em dropped e nunca cobrados. Códigos: no_country_code, too_short, too_long, not_a_number, wrong_length, not_covered, duplicate e suppressed (na sua lista de não enviar).

Obter ou listar envios

GET/api/v1/sends/{id}

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

Um único envio inclui counts por status de mensagem. As listas são as mais recentes primeiro; passe next_before como before para a próxima página. Envios do espaço de trabalho também aparecem aqui, com source: "web".

Mensagens

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 um envio

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

Apenas envios agendados que não começaram podem ser cancelados. O custo total retorna ao seu saldo e a resposta inclui refunded_usd.

Webhooks

Defina uma URL https no espaço de trabalho (API e webhooks). Enviamos um evento POST quando uma mensagem é entregue ou falha, para envios da API e do espaço de trabalho. Responda com qualquer status 2xx dentro de 10 segundos. Entregas falhas são tentadas novamente até 7 vezes no total: imediatamente, depois de 1 minuto, 5 minutos, 30 minutos, 1 hora, 2 horas e 3 horas. O espaço de trabalho mostra cada tentativa com seu status e resposta.

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": "..." } } }

A assinatura é HMAC-SHA256 de timestamp + "." + raw body com seu segredo de assinatura (começa com sso_whk_). Verifique no corpo bruto antes de analisar, rejeite timestamps mais antigos que 5 minutos e use o id de entrega para ignorar repetições.

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 e test do botão Enviar evento de teste.

Statuses e motivos

Motivos de falha (o campo reason):