Документация SMS API для отправки из вашего кода

Аутентификация

Отправьте ваш ключ в заголовке Authorization: Authorization: Bearer sso_live_.... Ключи состоят из 49 символов и начинаются с sso_live_. До 5 ключей на аккаунт; отзовите один в рабочем пространстве, и он перестанет работать сразу. Прайс-лист публичный и не требует ключа.

Ошибки

Ошибки используют HTTP статус-коды и JSON тело с устойчивым кодом и предложением, которое можно показать человеку. Ничего не списывается, если запрос завершается ошибкой.

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

Лимиты

• 240 запросов в минуту на ключ, отображается в X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset (в секундах Unix).
• 5,000 номеров на запрос, 2,000 символов на текст, 10 сегментов на сообщение.
• Сообщения отправляются до 300 в минуту на аккаунт.
• send_at от 10 минут до 30 дней вперед.

Цены

GET/api/v1/prices

GET/api/v1/prices/{country}

Цена за сообщение (один сегмент) для каждой страны, в USD с 5 знаками после запятой. Ключ не требуется.

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

Баланс аккаунта

GET/api/v1/account

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

Оценить стоимость

POST/api/v1/costs

Принимает те же данные, что и отправка, и возвращает стоимость, не отправляя и не списывая средства. Текст каждого получателя определяет количество сегментов, поэтому сумма точна.

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

Создать рассылку

POST/api/v1/sends

Один текст на один или несколько номеров. Средства за всю отправку списываются при ее принятии; неудачные сообщения возвращаются по одному.

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

Номера, которые нельзя отправить, перечислены в dropped и никогда не списываются. Коды: no_country_code, too_short, too_long, not_a_number, wrong_length, not_covered, duplicate и suppressed (в вашем списке запрещенных для отправки).

Получить или список рассылок

GET/api/v1/sends/{id}

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

Одна отправка включает counts по статусу сообщения. Списки отсортированы от новых к старым; передайте next_before как before для следующей страницы. Отправки из рабочего пространства также отображаются здесь с source: "web".

Сообщения

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

Отменить рассылку

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

Только запланированные отправки, которые еще не начались, могут быть отменены. Полная стоимость возвращается на ваш баланс, и ответ включает refunded_usd.

Вебхуки

Установите HTTPS URL в рабочем пространстве (API и вебхуки). Мы отправляем POST-запрос с событием, когда сообщение доставлено или не доставлено, для отправок как через API, так и через рабочее пространство. Ответьте с любым статусом 2xx в течение 10 секунд. Неудачные доставки повторяются до 7 раз: сразу, затем через 1 минуту, 5 минут, 30 минут, 1 час, 2 часа и 3 часа. Рабочее пространство показывает каждую попытку с ее статусом и ответом.

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

Подпись, это HMAC-SHA256 от timestamp + "." + raw body с вашим секретным ключом подписи (он начинается с sso_whk_). Проверьте ее на сыром теле перед разбором, отклоните временные метки старше 5 минут и используйте идентификатор доставки, чтобы игнорировать повторы.

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

События: message.delivered, message.failed и test с кнопки Отправить тестовое событие.

Статусы и причины

Причины неудачи (поле reason):