OMNI API — отправка кодов

Коротко: OMNI API отправляет одноразовые коды через SMS, WhatsApp, TTS и другие каналы. Поддерживает каскад и интеграцию с 2FA-сервисом.

Кому подходит

• Роль: Разработчик, Интегратор
• Уровень: Опытный

Эндпоинты

Полный URL: https://web.otpcod.ru/api/v1/....

Параметры запроса

*- нужен либо payload, либо template.

Таблица каналов для OTP

Отправка одного кода

Пример SMS с кодом:

curl --location 'https://web.otpcod.ru/api/v1/messages' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "contact": "905063565285",
    "channel": 1,
    "senderId": "<senderID>",
    "isOtp": true,
    "payload": {
      "text": "Ваш код: 1234"
    }
  }'

Пример WhatsApp-кода через шаблон:

curl --location 'https://web.otpcod.ru/api/v1/messages' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "contact": "905063565285",
    "channel": 4,
    "senderId": "<senderID>",
    "isOtp": true,
    "template": {
      "id": <templateID>,
      "params": {
        "attribute.phoneNumber": "905063565285",
        "attribute.code": "1234"
      }
    }
  }'

Каскадная отправка

Запрос POST /omnimessages принимает массив messages.

Пример: WhatsApp → SMS с двумя шаблонами

curl --location 'https://web.otpcod.ru/api/v1/omnimessages' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "contact": "<dnis>",
    "webhook": "<webhookURL>",
    "isOtp": true,
    "cooldown": 86400,
    "messages": [
      {
        "channel": 4,
        "senderId": "<senderID>",
        "successOn": "delivered",
        "timeout": 60,
        "template": {
          "id": <waTemplateID>,
          "params": {
            "attribute.code": "1234"
          }
        }
      },
      {
        "channel": 1,
        "senderId": "<senderID>",
        "template": {
          "id": <smsTemplateID>,
          "params": {
            "attribute.code": "1234"
          }
        }
      }
    ]
  }'

2FA-эндпоинты

Эти эндпоинты используются только при интеграции с 2FA-сервисом. Они используют Basic Auth и отдельный API-ключ интеграции.

Проверка кода

Эндпоинт: POST /2fa/verify

Параметры (form-data):

Пример:

curl -X POST https://<домен-OTP>/api/v1/2fa/verify \
  -u <API-ключ> \
  -d requestId=<requestId> \
  -d code=<код>

Успешный ответ:

{
  "number": "12345678910",
  "verifiedAt": 1234567890
}

Статус запроса

Эндпоинт: GET /2fa/requests/{requestId}

Пример:

curl https://<домен-OTP>/api/v1/2fa/requests/<requestId> \
  -u <API-ключ>

Успешный ответ:

{
  "id": "<requestId>",
  "number": "<номер>",
  "rate": 0.0248,
  "status": "SUBMIT",
  "sender": "<имя отправителя>",
  "goals": ["NUMBER_VERIFIED"],
  "createdAt": 1234567891011
}

Подробнее о настройке 2FA-интеграции — в статьях:

• Как настроить 2FA-интеграцию
• Принцип работы 2FA: на стороне платформы
• Принцип работы 2FA: на стороне клиента
• Проверка запроса 2FA

Коды ответов

Частые проблемы

См. также

Нужна помощь?

• OTP-коды: support@otpcod.ru