OMNI API — отправка сообщений

Коротко: OMNI API — единый интерфейс для отправки сообщений. Поддерживает отправку одного сообщения и каскадную отправку с автоматическим переключением между каналами.

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

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

Что такое OMNI API

OMNI API отправляет сообщения через единый эндпоинт. Не важно, какой канал вы используете — SMS, RCS, WhatsApp, Viber, Telegram и так далее, — структура запроса одна.

Два режима отправки:

• Одиночное сообщение — POST /messages — отправка через один канал.
• Каскад — POST /omnimessages — последовательная отправка через несколько каналов с автоматическим переключением.

Эндпоинты

Полный URL: https://web.multiapi.ru/api/v1/messages и https://web.multiapi.ru/api/v1/omnimessages.

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

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

Таблица каналов

Отправка одного сообщения

Запрос POST /messages отправляет сообщение через один канал.

Пример SMS:

curl --location 'https://web.multiapi.ru/api/v1/messages' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "contact": "905063565285",
    "channel": 1,
    "senderId": "<senderID>",
    "payload": {
      "text": "Тестовое сообщение"
    }
  }'

Полный ответ придёт кодом 202 Accepted с messageId. Факт доставки придёт асинхронно через вебхук.

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

Запрос POST /omnimessages принимает массив messages — по объекту на каждый канал.

Для каждого сообщения (кроме последнего) можно указать:

• successOn — статус, при котором сообщение считается успешным. Если он не наступит — платформа перейдёт к следующему сообщению.
• timeout — секунды ожидания successOn. По умолчанию 1200 (20 минут).

На верхнем уровне можно указать cooldown — секунды блокировки контакта при неудаче всего каскада.

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

curl --location 'https://web.multiapi.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": 2,
        "senderId": "<senderID>",
        "successOn": "delivered",
        "timeout": 60,
        "template": {
          "id": <rcsTemplateID>,
          "params": {
            "attribute.phoneNumber": "112332",
            "attribute.name": "test-name"
          }
        }
      },
      {
        "channel": 1,
        "senderId": "<senderID>",
        "template": {
          "id": <smsTemplateID>,
          "params": {
            "attribute.phoneNumber": "112332",
            "attribute.code": "1234"
          }
        }
      }
    ]
  }'

Отправка шаблонов

Для отправки сообщения по шаблону используйте параметр template вместо payload.

Пример отправки шаблона через RCS:

curl --location 'https://web.multiapi.ru/api/v1/messages' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "contact": "<dnis>",
    "webhook": "<webhookURL>",
    "channel": 2,
    "senderId": "<senderID>",
    "template": {
      "id": <templateID>,
      "params": {
        "attribute.phoneNumber": "112332",
        "attribute.name": "test-name"
      }
    }
  }'

Коды ответов

Пример успешного ответа:

{
  "error": false,
  "data": {
    "channel": 4,
    "transactionId": "95e3e0da-9684-4ba4-88a3-e9207ddeca05",
    "messageId": "6719b5f4-36af-4fba-b111-49ff07f4f96b"
  }
}

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

См. также

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

• Multi API: support@multiapi.ru