Обзор API OTP-кодов
API OTP-кодов — OMNI API, Broadcasts API и 2FA-эндпоинты. Отправка и проверка кодов, рассылки, Swagger UI
Коротко: OTP-сервис предоставляет доступ к двум группам API — OMNI API для отправки кодов и Broadcasts API для рассылок. Плюс специальные эндпоинты для 2FA-интеграции.
Кому подходит
- Роль: Разработчик, Интегратор
- Уровень: Опытный
Что такое API OTP-кодов
Через API OTP-сервиса можно:
- Отправлять одноразовые коды через SMS, WhatsApp, TTS, RCS, FlashCall и другие каналы.
- Запускать каскадную отправку с автоматическим переключением между каналами.
- Управлять рассылками и их шаблонами.
- Работать с 2FA-интеграцией: отправлять и проверять коды, получать статус запроса.
- Получать баланс, список каналов, имена отправителей, EDR-записи.
- Работать с шаблонами сообщений и WhatsApp.
Базовый URL
https://web.otpcod.ru/api/v1
Аутентификация
Заголовок X-API-Key с вашим API-ключом в каждом запросе.
Как получить ключ: API-ключи.
При создании ключа вы выбираете имена отправителей. От выбранных имён зависит, по каким каналам сможет отправлять ключ.
Три группы эндпоинтов
| Группа | Что делает | Доступна в OTP |
|---|---|---|
| OMNI API | Отправка кодов, работа с балансом, каналами, EDR, шаблонами | ✅ |
| Broadcasts API | Запуск рассылок, управление шаблонами рассылок | ✅ |
| 2FA-эндпоинты | Отправка и проверка кодов через 2FA-интеграцию | ✅ |
| Recipients API | Управление контактами, атрибутами, фильтрами | ❌ |
Recipients API в OTP-сервисе недоступен. Для работы с получателями используйте интерфейс «Мой диалог».
OMNI API — эндпоинты
| Метод | Эндпоинт | Для чего |
|---|---|---|
| POST | /messages | Отправка одного сообщения с кодом |
| POST | /omnimessages | Каскадная отправка |
| POST | /messages/revoke | Отозвать верификационное сообщение Telegram Gateway |
| POST | /messages/verification | Проверить статус верификации Telegram Gateway |
| GET | /balance | Баланс компании |
| GET | /channels | Список каналов, доступных компании |
| GET | /edrs | Записи о доставке сообщений |
| GET | /senders | Список имён отправителей компании |
| GET | /templates | Список шаблонов сообщений |
| GET | /wa_templates | Список шаблонов WhatsApp |
Broadcasts API — эндпоинты
| Метод | Эндпоинт | Для чего |
|---|---|---|
| POST | /broadcast/broadcasts | Запуск рассылки |
| GET | /broadcast/templates | Список шаблонов рассылок |
| POST | /broadcast/templates | Создать шаблон рассылки |
| GET | /broadcast/templates/{id} | Детали шаблона рассылки |
| PUT | /broadcast/templates/{id} | Обновить шаблон рассылки |
| DELETE | /broadcast/templates/{id} | Удалить шаблон рассылки |
2FA-эндпоинты
Специальные эндпоинты для 2FA-интеграции. Используют Basic Auth, а не X-API-Key. Ключ и URL выдаются при настройке интеграции в разделе 2FA Service.
| Метод | Эндпоинт | Для чего |
|---|---|---|
| POST | /2fa/verify | Проверить введённый код |
| GET | /2fa/requests/{requestId} | Получить статус 2FA-запроса |
Подробнее о работе 2FA-интеграции — в статьях:
- Принцип работы 2FA: на стороне платформы
- Принцип работы 2FA: на стороне клиента
- Получение обратных вызовов при 2FA
- Проверка запроса 2FA
Swagger UI
- OMNI API: https://web.otpcod.ru/api/v1/swagger-ui/index.html?urls.primaryName=OMNI_API
- Broadcasts API: https://web.otpcod.ru/api/v1/swagger-ui/index.html?urls.primaryName=Broadcasts_API
Что дальше
Нужна помощь?
- OTP-коды: support@otpcod.ru