Получение сообщения от клиента

Все сообщения пользователя приходят с типом события message_created.

circle-info

типы сообщений

  • text — текстовое сообщение

  • postback — нажатие пользователем на кнопку в чат-боте

  • image — изображение

  • document — файл

  • unknown — неподдерживаемый формат (например, отправка контакта пользователем)

1. Текстовое сообщение (полный webhook)

{
  "event_type": "message_created",
  "payload": {
    "chat": {
      "uuid": "uuid пользователя",
      "avatar": "ссылка на аватар пользователя",
      "platform": "мессенджер",
      "phone": "номер телефона пользователя",
      "name": "имя пользователя"
    },
    "profile": {
      "uuid": "uuid профиля пользователя"
    },
    "message": {
      "uuid": "uuid сообщения",
      "type": "text",
      "text": "сообщение пользователя"
    },
    "session": {
      "title": null,
      "context": null,
      "team": {
        "id": "id команды",
        "name": "название команды"
      }
    }
  },
  "timestamp": 1777966993528
}
chevron-rightОписание параметровhashtag

chat

  • uuid — уникальный идентификатор чата

  • avatar — аватар пользователя (при наличии)

  • platform — канал (Telegram, WhatsApp и т.д.)

  • phone — телефон (если доступен)

  • name — имя пользователя

profile

  • uuid — идентификатор профиля пользователя

session

  • title — заголовок чат-сессии (может быть null)

  • context — контекст чат-сессии (может быть null)

  • team.id — ID команды (число)

  • team.name — название команды

message

  • uuid — уникальный ID сообщения

  • type — тип текстового сообщения

  • text — содержимое сообщения

2. Кнопка (postback)

chevron-rightОписание параметровhashtag

message

  • uuid — уникальный ID сообщения

  • type — тип события нажатия на кнопку в сценарии чат-бота

  • text — название кнопки

3. Изображение

chevron-rightОписание параметровhashtag

message

  • uuid — уникальный ID сообщения

  • type — тип сообщения при получении сообщения изображения от пользователя

  • url — ссылка на изображение

  • caption — описание от пользователя к изображению, может быть null

4. Файл

chevron-rightОписание параметровhashtag

message

  • uuid — уникальный ID сообщения

  • type — тип сообщения при получении сообщения файла от пользователя

  • url — ссылка на файл

  • caption — описание от пользователя к файлу, может быть null

5. Неподдерживаемый формат

chevron-rightОписание параметровhashtag

message

  • uuid — уникальный ID сообщения

  • type — тип сообщения при отправке пользователем неподдерживаемого типа контента

  • error — описание ошибки

Last updated