Первый запрос через умный шлюз
Отправка первого запроса через умный шлюз — параметры, примеры
Первый запрос через умный шлюз
Коротко: запрос через умный шлюз содержит код и правила доставки. Один запрос — платформа сама отправит по каналам.
Кому подходит
- Роль: Разработчик
- Уровень: Опытный
Что вы получите
Отправленное сообщение с кодом через выбранные каналы.
Перед началом
- Есть API-ключ.
- Есть имя отправителя со статусом Активно.
- Вы понимаете структуру каскада.
Шаги
Шаг 1. Отправьте POST-запрос
URL: https://web.otpcod.ru/api/v1/omnimessages
Заголовки:
- Content-Type: application/json
- X-API-Key: ваш-ключ
Шаг 2. Укажите основные параметры
| Параметр | Что указать |
|---|---|
| contact | Номер получателя |
| isOtp | true — флаг, что это OTP |
| webhook | URL для получения статусов |
| cooldown | Время блокировки контакта при неудаче (секунды) |
| messages | Массив сообщений с каскадом |
Шаг 3. Настройте каскад
В массиве messages укажите сообщения для каждого канала:
| Поле | Что указать |
|---|---|
| channel | Номер канала (1 = SMS, 2 = RCS, 4 = WhatsApp) |
| contact | Номер получателя |
| senderId | Имя отправителя |
| successOn | Статус успеха: sent, delivered, seen |
| timeout | Таймаут до перехода на следующий канал |
| payload | Содержимое сообщения с кодом |
Шаг 4. Отправьте запрос
Платформа примет запрос и начнёт отправку по каскаду.
Шаг 5. Получите статусы
На указанный webhook будут приходить статусы доставки.
Пример логики
- Платформа отправляет сообщение по WhatsApp.
- Ждёт статус delivered 10 минут.
- Если не получен — переходит на SMS.
- Ждёт статус delivered 10 минут.
- Если не получен — переходит на TTS.
Что важно помнить
- Каскад настраивается в запросе. Не в интерфейсе.
- Один запрос — вся цепочка. Не нужно отправлять несколько.
- Статусы приходят на вебхук. Настройте endpoint заранее.
Результат
Сообщение отправлено. Вы получили статус доставки.
Что дальше
См. также
Нужна помощь?
- OTP-коды: support@otpcod.ru