Руководство для разработчиков

Отправьте первое SMS за 15 минут

Пошаговая инструкция: от запуска SMSC-симулятора до отправки и проверки статуса SMS через REST API. Реальный SMSC не требуется.

1

Запустите SMSC-симулятор

Для тестирования не нужен реальный SMSC-центр. Используйте симулятор (http://www.seleniumsoftware.com), который полностью эмулирует поведение SMSC: принимает SMPP-соединения, обрабатывает submit_sm и возвращает delivery receipts.

Симулятор максимально близок к реальному SMSC — идеален для разработки и тестирования
Terminal
# Pull the SMSC simulator image
docker pull ernestmr/smscsimulator

# Run the simulator (SMPP port 2775)
docker run -d --name smsc-simulator \
  -p 2775:2775 \
  ernestmr/smscsimulator
2

Разверните SMS-PROXY Gateway

SMS-PROXY Gateway — это ядро системы: маршрутизация, балансировка нагрузки, REST/gRPC API и мониторинг. Подключите его к запущенному SMSC-симулятору.


Подробная инструкция по развёртыванию SMS-PROXY Gateway будет добавлена в ближайшее время.

Следите за обновлениями в документации.
3

Получите токен авторизации

Все запросы к SMS API требуют JWT-токен и идентификатор приложения. Отправьте POST-запрос на эндпоинт логина, чтобы получить токен.

Login Request
curl -X POST http://127.0.0.1:8088/api/v1/user/login \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": 1,
    "email": "admin@example.com",
    "password": "digital"
  }'

# Response:
# {
#   "token": "eyJhbGciOiJIUzI1NiIs...",
#   "error": ""
# }
Сохраните token — он понадобится для заголовка Authorization: Bearer
4

Отправьте SMS

Используйте полученный токен для отправки SMS через REST API. Выберите язык программирования — примеры включают авторизацию и отправку.

REST / cURL
curl -X POST http://127.0.0.1:8088/api/v1/sms/send \
  -H "Authorization: Bearer <token>" \
  -H "X-App-ID: 1" \
  -H "Content-Type: application/json" \
  -d '{
    "task_id": 11,
    "transaction_id": "1C439986-E1E9-4697-A127-4079EF1180D9",
    "app_id": 1,
    "esme": 10,
    "ston": 0,
    "snpi": 5,
    "saddr": "UNIQUBIC",
    "dnpi": 1,
    "dton": 1,
    "daddr": "998901234567",
    "message": "Your verification code: 4821",
    "sent_at": 1937082918,
    "strategy": "default"
  }'

# Response:
# {
#   "success": true,
#   "message_id": "24f03dc0-adf3-407f-a886-202cd23c2ae9",
#   "status": "ACCEPTED",
#   "sms_ids": ["2239425"],
#   "task_id": 11
# }
5

Проверьте статус доставки

После отправки SMS вы можете проверить статус доставки по message_id, полученному в ответе на шаге 4.

Check Delivery Status
curl -X POST http://127.0.0.1:8088/api/v1/sms/info \
  -H "Authorization: Bearer <token>" \
  -H "X-App-ID: 1" \
  -H "Content-Type: application/json" \
  -d '{
    "esme": 10,
    "message_id": "24f03dc0-adf3-407f-a886-202cd23c2ae9"
  }'

# Response:
# {
#     "message_id": "24f03dc0-adf3-407f-a886-202cd23c2ae9",
#     "mode": "single",
#     "parts": {
#         "2239425": "DELIVRD"
#     },
#     "delivered_count": 1,
#     "sent_at": 1775237847,
#     "updated_at": 1775237847,
#     "transaction_id": "1c439986-e1e9-4697-a127-4079ef1180d9",
#     "task_id": 11,
#     "status": "DELIVRD",
#     "error": ""
# }

SMS отправлено. Что дальше?

Изучите полный API-справочник, настройте SMPP-пулы и масштабируйте систему под ваши задачи.