Перейти до вмісту
OmniMessage

Типи повідомлень

Дев’ять типів повідомлень, одне тіло запиту

У запиті на надсилання вказуються канал, одержувач і тип, а вміст розміщується під ключем, названим за типом. На цій сторінці показано кожен тип, тіло запиту, що його створює, і канали, де він підтримується.

Відкрити довідник APIПорівняти канали

Матриця підтримки

Який канал приймає який тип

Канал повідомляє, що він приймає, у полі capabilities. Надсилання типу, який канал не підтримує, повертає 400 unsupported_message_type, і нічого не списується.

Підтримка типів повідомлень за типами каналів
ТипWhatsAppSMSSMS OTPTelegramMessengerInstagramTikTok
ТекстtextПідтримуєтьсяПідтримуєтьсяПідтримуєтьсяПідтримуєтьсяПідтримуєтьсяПідтримуєтьсяПідтримується
ВкладенняattachmentsПідтримуєтьсяПідтримуєтьсяНе підтримуєтьсяПідтримуєтьсяПідтримуєтьсяПідтримуєтьсяПідтримується
ШаблонtemplateПідтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримується
Кнопки відповідіbuttonПідтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяПідтримуєтьсяПідтримуєтьсяПідтримуєтьсяПідтримується
СписокlistПідтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримується
URL-кнопкаcta_urlПідтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримується
ГеолокаціяlocationПідтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяПідтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримується
КонтактиcontactsПідтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяПідтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримується
ОпитуванняpollНе підтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяПідтримуєтьсяНе підтримуєтьсяНе підтримуєтьсяНе підтримується
type: "text"

Текст

Звичайний текст, який приймають усі типи каналів. Установіть preview_url, щоб канал показав попередній перегляд посилання.

body: від 1 до 4096 символів.

  • WhatsApp Business
  • SMS
  • SMS OTP
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "text",
  "text": {
    "body": "Ваше замовлення #1042 відправлено. Відстежити його можна тут: https://example.com/t/1042",
    "preview_url": true
  },
  "reference": "order-1042"
}
type: "attachments"

Вкладення

Один медіаелемент на повідомлення, заданий URL-адресою https: зображення, відео, документ, аудіо, голосове повідомлення або стікер, з необов’язковим підписом.

Рівно один елемент. caption: до 1024 символів.

  • WhatsApp Business
  • SMS
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "attachments",
  "attachments": [
    {
      "type": "image",
      "url": "https://example.com/receipts/1042.jpg",
      "caption": "Ваша квитанція за замовлення #1042."
    }
  ]
}
type: "template"

Шаблон

Схвалений шаблон WhatsApp зі змінними. Шаблони — єдині повідомлення, які WhatsApp приймає поза 24-годинним вікном обслуговування клієнтів.

name і language мають відповідати схваленому шаблону каналу.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "template",
  "template": {
    "name": "order_out_for_delivery",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Олена"
          },
          {
            "type": "text",
            "text": "#1042"
          },
          {
            "type": "text",
            "text": "18:00"
          }
        ]
      }
    ]
  }
}
type: "button"

Кнопки відповіді

Повідомлення, що містить до трьох швидких відповідей. Ідентифікатор натиснутої кнопки повертається на ваш вебхук у події message.received.

Від 1 до 3 кнопок. title: до 20 символів.

  • WhatsApp Business
  • Telegram
  • Messenger
  • Instagram
  • TikTok
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "button",
  "button": {
    "body": {
      "text": "Ваш столик на двох заброньовано на сьогодні на 19:30. Ви зможете прийти?"
    },
    "action": {
      "buttons": [
        {
          "reply": {
            "id": "confirm",
            "title": "Підтвердити"
          }
        },
        {
          "reply": {
            "id": "reschedule",
            "title": "Перенести"
          }
        },
        {
          "reply": {
            "id": "cancel",
            "title": "Скасувати бронь"
          }
        }
      ]
    }
  }
}
type: "list"

Список

Меню, що відкривається однією кнопкою, з рядками, згрупованими в розділи із заголовками.

action.button: до 20 символів.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "list",
  "list": {
    "body": {
      "text": "Який відділ може вам сьогодні допомогти?"
    },
    "action": {
      "button": "Вибрати відділ",
      "sections": [
        {
          "title": "Відділи",
          "rows": [
            {
              "id": "orders",
              "title": "Замовлення",
              "description": "Доставка, повернення товарів і коштів"
            },
            {
              "id": "billing",
              "title": "Оплата",
              "description": "Рахунки та способи оплати"
            },
            {
              "id": "technical",
              "title": "Технічна підтримка",
              "description": "Налаштування та усунення несправностей"
            }
          ]
        }
      ]
    }
  }
}
type: "cta_url"

URL-кнопка

Повідомлення з однією кнопкою, що відкриває URL-адресу: для сторінок відстеження, платежів і посилань для входу.

Одна кнопка на повідомлення.

  • WhatsApp Business
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "cta_url",
  "cta_url": {
    "body": {
      "text": "Ваша посилка вже в дорозі. Стежте за нею в реальному часі."
    },
    "action": {
      "parameters": {
        "display_text": "Відстежити посилку",
        "url": "https://example.com/t/1042"
      }
    }
  }
}
type: "location"

Геолокація

Позначка на карті з назвою та адресою, що відкривається в картографічному застосунку одержувача.

latitude і longitude задаються в десяткових градусах.

  • WhatsApp Business
  • Telegram
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "location",
  "location": {
    "latitude": 25.2048,
    "longitude": 55.2708,
    "name": "Пункт видачі",
    "address": "Шосе шейха Заїда, Дубай"
  }
}
type: "contacts"

Контакти

Одна або кілька карток контактів. Масив передається в канал без змін, тому в ньому використовується формат контактів самого провайдера.

У прикладі показано формат контактів WhatsApp.

  • WhatsApp Business
  • Telegram
POST /v1/messages
{
  "channel": "ch_7Hq2mN5vB8cX1zL0pK3j",
  "to": "+971501234567",
  "type": "contacts",
  "contacts": [
    {
      "name": {
        "formatted_name": "Служба підтримки",
        "first_name": "Підтримка"
      },
      "phones": [
        {
          "phone": "+971800123456",
          "type": "WORK"
        }
      ]
    }
  ]
}
type: "poll"

Опитування

Нативне опитування Telegram із запитанням і набором варіантів відповіді.

Лише Telegram.

  • Telegram
POST /v1/messages
{
  "channel": "ch_4Tn8rW2yK6dF9sA1mQ5v",
  "to": "584201337",
  "type": "poll",
  "poll": {
    "question": "Коли доставити ваше замовлення?",
    "options": [
      "Уранці, з 09:00 до 12:00",
      "Удень, з 12:00 до 17:00",
      "Увечері, з 17:00 до 21:00"
    ]
  }
}

Спробуйте всі типи в пісочниці

У кожному акаунті є канал-пісочниця для кожного типу каналу. Надсилайте з тестовим ключем будь-який тип, який він підтримує, — нічого не доставляється і не оплачується.

Отримати API-ключЧитати документацію