Входящие события и сообщения (от пользователя)

Описание и примеры сообщений, которые могут отправлять пользователи API-канала.

Входящие сообщения – это любые данные (текст, изображения, файлы или служебные команды), которые приходят от пользователей через ваш чат, мессенджер или приложение и которые ваша система передаёт в Fasttrack на указанный вебхук-адрес для дальнейшей обработки.

Базовый пример

{
  "chat": {
    "client_id": "e937a119-baf5-4aa4-aa21-42795043e236",
    "name": "Иван"
  },
  "id": 1323,
  "payload": {
    // ... зависит от payload.type
  },
  "meta": {
    // ... доп. информация в контексте сообщения
  }
  "timestamp": 1744214074793
}

Корневые элементы

• chat object * – Информация о пользователе канала.

• id string – Идентификатор сообщения на вашей стороне. - ограничение: 64 символа

• payload object * – Содержание сообщения от пользователя.

• timestamp integer or null (date-time) – Временная метка. - unix timestamp

• meta object – Доп. информация в контексте сообщения

Объект chat

• client_id string * – Идентификатор пользователя на вашей стороне.

• name string * – Имя пользователя в канале.

Объект payload

• type string * – Тип контента. - варианты "text" "image" "video" "audio" "document" "location"

Содержание сообщений

Команда /start

{
  // ...
  "payload": {
    "type": "text",
    "text": "/start",
    "deeplink_params": {
      "c": "123",
      "n": "1000"
    }
  }
}

Объект payload

• type string * – Тип контента. - значение "text"

• text string * – Команда. - значение "/start"

• deeplink_params object – Параметры диплинка.

Объект deeplink_params

• c string * – Идентификатор диплинка.

• n string * – Идентификатор сценария (узла).

Сообщение с текстом

{
  // ...
  "payload": {
    "type": "text",
    "text": "Добрый день!"
  }
}

Объект payload

• type string * – Тип контента. - значение "text"

• text string – Текст сообщения.

Сообщение с картинкой

{
  // ...
  "payload": {
    "type": "image",
    "url": "",
    "capture": "This is example image."
  }
}

Объект payload

• type string * – Тип контента. - значение "image"

• url string * – Ссылка на изображение.

• capture string – Подпись к изображению.

Сообщение с файлом

{
  // ...
  "payload": {
    "type": "document",
    "url": "",
    "capture": "This is example file."
  }
}

Объект payload

• type string * – Тип контента. - значение "document"

• url string * – Ссылка на файл.

• capture string – Подпись к файлу.

Видео-сообщение

{
  // ...
  "payload": {
    "type": "video",
    "url": "",
    "capture": "This is example video."
  }
}

Объект payload

• type string * – Тип контента. - значение "video"

• url string * – Ссылка на видео.

• capture string – Подпись к видео.

Аудио-сообщение

{
  // ...
  "payload": {
    "type": "audio",
    "url": "",
    "capture": "This is example audio."
  }
}

Объект payload

• type string * – Тип контента. - значение "audio"

• url string * – Ссылка на аудио.

• capture string – Подпись к аудио.

Локация

{
  // ...
  "payload": {
    "type": "location",
    "lat": "-15.793889",
    "lng": "-47.882778"
  }
}

Объект payload

• type string * – Тип контента. - значение "location"

• lat string – Долгота.

• lng string – Широта.