Към съдържанието
OmniMessage

Типове съобщения

Девет типа съобщения, едно тяло на заявката

Заявката за изпращане посочва канал, получател и тип, а съдържанието стои под ключ с името на типа. Тази страница показва всеки тип, тялото, което го създава, и къде се поддържа.

Към справочника за APIСравнете каналите

Таблица на поддръжката

Кой канал кой тип приема

Каналът съобщава какво приема в capabilities. Изпращането на тип, който каналът не поддържа, връща 400 unsupported_message_type и нищо не се таксува.

Поддръжка на типовете съобщения по тип канал
ТипWhatsAppSMSSMS OTPTelegramMessengerInstagramTikTok
ТекстtextПоддържа сеПоддържа сеПоддържа сеПоддържа сеПоддържа сеПоддържа сеПоддържа се
Прикачени файловеattachmentsПоддържа сеПоддържа сеНе се поддържаПоддържа сеПоддържа сеПоддържа сеПоддържа се
ШаблонtemplateПоддържа сеНе се поддържаНе се поддържаНе се поддържаНе се поддържаНе се поддържаНе се поддържа
Бутони за отговорbuttonПоддържа сеНе се поддържаНе се поддържаПоддържа сеПоддържа сеПоддържа сеПоддържа се
СписъкlistПоддържа сеНе се поддържаНе се поддържаНе се поддържаНе се поддържаНе се поддържаНе се поддържа
Бутон с URLcta_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"

Прикачени файлове

Един мултимедиен елемент на съобщение, посочен чрез https URL: изображение, видео, документ, аудио, гласово съобщение или стикер, с надпис по избор.

Точно един елемент. 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"
    ]
  }
}

Изпробвайте всеки тип в sandbox средата

Всеки акаунт има sandbox канал за всеки тип канал. Изпратете с тестов ключ произволен тип, който каналът поддържа – нищо не се доставя и не се таксува.

Вземете API ключВижте документацията