1rub-sms
На главную

Документация API

Профиль локального стенда «Цифровые SMS 2.0». Токен HTTP и реквизиты SMPP выдаются отдельно для каждого клиента.

Отправить SMS по HTTP

Передайте номер в международном формате с плюсом и текст в UTF-8. Для новой отправки задайте уникальный ключ. При сетевом сбое повторите запрос с прежним ключом и теми же данными.

POST /v1/messages
Authorization: Bearer <токен клиента>
Idempotency-Key: order-1042-ready
Content-Type: application/json

{
  "recipient": "+79990000001",
  "text": "Заказ № 1042 готов к выдаче."
}

При принятии центр возвращает HTTP 202 и квитанцию с полями message_id, intake_seq, received_at, segments и status. Сохраните message_id.

При платном пропуске каждой N-й SMS значение status — «Отправлено». Оно обозначает подачу сообщения в центр. Поле status_detail поясняет, что дальнейшая отправка пропущена по правилу агрегатора. Для SMS, поданной через SMPP, клиент получает тот же статус по HTTP с ID из ответа submit_sm_resp.

Проверить состояние

GET /v1/messages/<message_id>
Authorization: Bearer <токен клиента>

Ответ HTTP 200 содержит текущее состояние SMS. Ошибка 401 означает, что нужен действующий токен. При ответе 409 проверьте причину конфликта, при 422 — номер, текст и ключ. Эмодзи в тексте отклоняются.

Подключиться по SMPP

Локальная точка подключения — 127.0.0.1:12775. Откройте bind_transceiver с выданными system_id и паролем. Для submit_sm передайте ключ отправки в стендовом TLV 0x1400. Профиль принимает одиночный short_message с data_coding=1 для ASCII или 8 для Unicode в big endian.