Documentazione API SMS per l'invio dal tuo codice

Autenticazione

Invia la tua chiave nell'header Authorization: Authorization: Bearer sso_live_.... Le chiavi sono lunghe 49 caratteri e iniziano con sso_live_. Fino a 5 chiavi per account; revocane una nell'area di lavoro e smetterà di funzionare immediatamente. La lista prezzi è pubblica e non richiede una chiave.

Errori

Gli errori utilizzano codici di stato HTTP e un corpo JSON con un codice stabile e una frase che puoi mostrare a una persona. Non viene addebitato nulla quando una richiesta fallisce.

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

Limiti

• 240 richieste al minuto per chiave, mostrate in X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset (secondi unix).
• 5,000 numeri per richiesta, 2,000 caratteri per testo, 10 segmenti per messaggio.
• I messaggi partono fino a 300 al minuto per account.
• send_at da 10 minuti a 30 giorni in anticipo.

Prezzi

GET/api/v1/prices

GET/api/v1/prices/{country}

Il prezzo per messaggio (un segmento) per ogni paese, in USD con 5 decimali. Nessuna chiave necessaria.

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

Credito dell'account

GET/api/v1/account

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

Stima un costo

POST/api/v1/costs

Prende lo stesso corpo di un invio e restituisce il costo, senza inviare o addebitare. Il testo unito di ciascun destinatario decide i suoi segmenti, quindi il totale è esatto.

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

Crea un invio

POST/api/v1/sends

Un testo a uno o più numeri. Il credito per l'intero invio viene prelevato quando viene accettato; i messaggi falliti vengono rimborsati uno per 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" } ]
}

I numeri che non possono essere inviati sono elencati in dropped e mai addebitati. Codici: no_country_code, too_short, too_long, not_a_number, wrong_length, not_covered, duplicate e suppressed (nella tua lista di non invio).

Ottieni o elenca gli invii

GET/api/v1/sends/{id}

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

Un singolo invio include counts per stato del messaggio. Le liste sono ordinate dal più recente; passa next_before come before per la pagina successiva. Gli invii dall'area di lavoro appaiono qui, con source: "web".

Messaggi

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

Annulla un invio

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

Solo gli invii programmati che non sono iniziati possono essere annullati. Il costo totale viene restituito al tuo credito e la risposta include refunded_usd.

Webhook

Imposta un URL https nell'area di lavoro (API e webhook). Inviiamo un evento POST quando un messaggio viene consegnato o fallisce, sia per gli invii dall'API che dall'area di lavoro. Rispondi con qualsiasi stato 2xx entro 10 secondi. Le consegne fallite vengono ritentate fino a 7 volte in totale: subito, poi dopo 1 minuto, 5 minuti, 30 minuti, 1 ora, 2 ore e 3 ore. L'area di lavoro mostra ogni tentativo con il suo stato e risposta.

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 è HMAC-SHA256 di timestamp + "." + raw body con il tuo segreto di firma (inizia con sso_whk_). Controllala sul corpo grezzo prima di analizzarlo, rifiuta timestamp più vecchi di 5 minuti e usa l'id di consegna per ignorare le ripetizioni.

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);
}

Eventi: message.delivered, message.failed, e test dal pulsante Invia evento di test.

Stati e motivi

Motivi di fallimento (il campo reason):