API для OTP-кодов
API OTP-сервиса — эндпоинты для отправки и проверки кодов верификации
API для OTP-кодов
Коротко: API OTP-сервиса позволяет отправлять коды верификации, проверять их и получать статусы. Два режима работы: под ключ и умный шлюз.
Кому подходит
- Роль: Разработчик
- Уровень: Опытный
Базовый URL
Аутентификация
Заголовок X-API-Key с вашим ключом. Как получить ключ: API-ключи.
Основные эндпоинты
Отправка и проверка кодов
| Эндпоинт | Метод | Для чего |
|---|---|---|
| /messages | POST | Отправка одного кода |
| /omnimessages | POST | Отправка с каскадом |
| /messages/verification | POST | Проверка статуса верификации |
| /messages/revoke | POST | Отзыв кода (Telegram Gateway) |
Справочные
| Эндпоинт | Метод | Для чего |
|---|---|---|
| /balance | GET | Баланс компании |
| /channels | GET | Список каналов |
| /senders | GET | Список имён отправителей |
| /edrs | GET | Записи о доставке |
| /templates | GET | Шаблоны сообщений |
2FA-сервис (режим «Под ключ»)
| Эндпоинт | Метод | Для чего |
|---|---|---|
| /2fa/requests/{requestId} | GET | Проверка статуса 2FA-запроса |
| /2fa/verify | POST | Проверка кода от пользователя |
Форматы запросов
Все запросы — POST или GET с заголовками:
- Content-Type: application/json
- X-API-Key: ваш-ключ
Примеры
Подробнее о примерах запросов — в Swagger UI:
https://web.otpcod.ru/api/v1/swagger-ui/index.html?urls.primaryName=OMNI_API
Что можно делать
- Отправлять OTP-коды через SMS, WhatsApp, TTS, RCS, FlashCall.
- Проверять статус отправки.
- Работать в режиме «Под ключ» — платформа генерирует и проверяет код.
- Работать в режиме «Умный шлюз» — вы генерируете код, платформа доставляет.
См. также
Нужна помощь?
- OTP-коды: support@otpcod.ru