Бипуим: Документация
8-800-505-24-05Сайт Бипиум
  • 😎Отвечаем на ваши вопросы
  • 🎂Версии и обновления
  • ❗Обновление до версии 2.0
  • Документация
    • 🆕С чего начать
      • Регистрация и вход
      • Создаем каталоги и записи
      • Формируем отчёты
      • Настраиваем правовую политику
      • Применяем автоматизации
    • ⚙️Конструктор данных
      • Отделы
      • Каталоги
        • Редактирование структуры
        • Настройка отображения
        • Поиск и фильтрация
        • Импорт записей
          • 📗Импорт из Excel
        • Экспорт записей
        • Активность
      • Системные каталоги
        • Сотрудники
        • События
        • Внешние запросы
        • Сценарии
        • Процессы
        • Доступ к сервисам
        • Вебхуки
      • Виды
      • Записи
    • 📊Отчеты
      • Графики
    • 🔑Права
      • Правила
      • Привилегии
      • Правовые группы
      • Правовые виды
      • Права на поля
      • Комбинация прав
    • 🤖Автоматизации
      • События
        • Изменение данных
        • Внешние запросы
      • Сценарии
        • Компоненты
          • Начало процесса
          • Конец процесса
          • Таймер
          • Ошибка
          • Шлюз «ИЛИ» (условное ветвление)
          • Шлюз «И» (распараллеливание)
          • Получить запись
          • Найти записи
          • Изменить запись
          • Создать запись
          • Удалить запись
          • Структура каталога
          • Загрузить файл
          • Сгенерировать документ
          • Назначение переменных
          • Код (Javascript)
          • Веб-запрос
          • SQL-запрос
          • Конвертер
          • Парсер
          • Запуск процесса
          • Получение почты
          • Отправка почты
          • Соединяющая линия
          • Отправить сообщение
        • Переменные
        • Выражения
        • Входные и выходные параметры компонентов
        • Примеры настройки
          • Условие
          • Цикл
      • Ограничения
  • Лицензии
    • 🌐Тип лицензирования
  • Примеры
    • 🔑Права доступа к данным
    • 🤖Автоматизации
      • Выгрузка файлов на Яндекс Диск
      • Отправка на больничный
      • Автоматизация оплаты счетов
      • Создание наименований записей
      • Расчет скидок для клиентов
      • Запрет на создание дубликатов в каталоге
      • Автозаполнение данных по ИНН
      • Переброс данных между связанными каталогами
      • Очередь сценариев
      • Отслеживание заявок с сайта помощью UTM-меток
      • Просрочка задач по дедлайну
      • Реализация механизма согласования записей
      • Массовое изменение записей
      • Создание каталога для рассылки почты
      • Перенос данных между системами Бипиума
      • Импорт данных из Excel
      • Генерация счет-фактуры
      • Генерация excel-отчетов
      • Планировщик задач
      • Импорт банковских выписок
      • Производственный календарь
      • Складской учет
  • Интеграции
    • 🥂Методы интеграции
      • Интеграция данных
        • API
        • Вебхуки (webhooks)
      • Интеграция интерфейса
        • Веб-формы
        • Веб-расширения
      • Примеры интеграций
        • Тильда
          • Прием данных с формы Tilda
          • Интеграция веб-интерфейса в Tilda
        • Интеграция с сервисом «DaData»
        • Интеграция c «Единой информационной системой в сфере закупок»
        • Мессенджеры
          • Интеграция с Telegram-ботом
        • Почтовые сервисы
          • UniSender
          • MailChimp
        • Сервисы Google
          • Google Calendar
        • Телефония
          • Oktell
            • Панель телефонии Oktell
            • Компонент Bpium в Oktell
        • 1C
    • 🔌API
      • Данные
        • Каталоги (Catalogs)
        • Записи (Records)
        • Связи (Relations)
        • Истории (Histories)
        • Файлы (Files)
        • Отделы (Sections)
        • Виды (Views)
        • Сообщения (Messages)
      • Агрегация
        • Разложения (Values)
        • Сводка (Totals)
      • Отчеты
        • Дашборды (Boards)
        • Графики (Widgets)
      • Поисковые выборки
        • Доступные связи (AvailableRecords)
        • Доступные условия фильтра (AvailableFilterRecords)
        • Сотрудники (Users)
        • Контакты (Contacts)
      • Права (Rights)
      • Профиль (Profile/me)
  • Установка на сервер
    • 🧱Архитектура
      • Варианты разворачивания
    • 🖥️Требования
    • 📂Установка как служба
    • 🛳️Установка через Docker
    • 🎛️Мультидоменная среда
    • 🆘Материалы
      • TLS/SSL Сертификат
      • Параметры config.env
        • Для Bpium
        • Для Bpium S3
        • Для Bpium BPM
      • Запуск
      • Обсуживание
        • Активация
        • Обновление
        • Бэкап и восстановление базы
        • Брендирование (Whitelabel)
        • Удаление
      • Перенос базы из облака
      • Возможные проблемы в ходе установки и работы
  • Обучение
    • Базовый курс
      • Урок 1. Отделы
      • Урок 2. Каталоги с данными
      • Урок 3. Карточки записей
      • Урок 4. Связи между данными
      • Урок 5. Фильтры и виды
      • Урок 6. Приглашение сотрудников
      • Урок 7. Права доступа к данным
      • Урок 8. Графические отчеты
      • Урок 9. Бизнес-процессы
      • Урок 10. Интеграции
    • Технический курс
      • Урок 1. Принцип работы автоматизаций
      • Урок 2. Первая автоматизация изнутри
      • Урок 3. Валидация данных
      • Урок 4. Простые вычисления
      • Урок 5. Расчет суммы заказа
      • Урок 6. Генерация счетов/документов
      • Урок 7. Рассылка почтовых сообщений
      • Урок 8. Прием внешних данных
      • Урок 9. Отправка данных на сторонние сервисы
    • Паттерны проектирования ИС
      • Унификация
      • Упорядоченность
      • Разделение
      • Актуализация
      • Вынос параметров
      • Выделение позиций
      • Слияние
      • Дублирование
      • Типизация
      • Информирование
Powered by GitBook
On this page
  • Получить сообщение с записи
  • Создать сообщение
  • Изменить сообщение
  • Удалить сообщение
  • Подписаться на сообщения в записи
  1. Интеграции
  2. API
  3. Данные

Сообщения (Messages)

Сообщения - ресурс платформы, манипулирующий с сообщениями в каждой записи в Бипиуме.

Получить сообщение с записи

URL: {domain}/api/v1/catalogs/{catalogId}/records/{recordId}/messages

Метод: GET

Параметры:

  • catalogId (number) — идентификатор каталога

  • recordId (number) — идентификатор записи

Ответ: 200 OK (application/json)

[
  {
    "id": "52",
    "catalogId": "$messages",
    "author": {
      "sectionId": "1",
      "sectionDbId": 1,
      "catalogDbId": 3,
      "catalogId": "$users",
      "catalogTitle": "Сотрудники",
      "catalogIcon": "users-1",
      "recordDbId": 11,
      "recordId": "11",
      "recordTitle": "admin",
      "isRemoved": false
    },
    "attachments": [],
    "createdDate": "2024-06-04T04:24:44.146Z",
    "deleted": false,
    "deletedDate": null,
    "mention": [],
    "reply": null,
    "text": "Привет!",
    "updatedDate": null
  },
]

Создать сообщение

URL: {domain}/api/v1/catalogs/{catalogId}/records/{recordId}/messages

Метод: POST

Параметры:

  • catalogId (number) — идентификатор каталога

  • recordId (number) - идентификатор записи

Запрос: (application/json)

{
  "text": "Как дела?",
  "mentions": [],
  "attachments": [],
  "replyMessageId": null
}

Ответ: 200 OK (application/json)

{
    "id": "7" // идентификатор созданного вида
}

Изменить сообщение

URL: {domain}/api/v1/catalogs/{catalogId}/records/{recordId}/messages/{messageId}

Метод: PATCH

Параметры:

  • catalogId (number) — идентификатор каталога

  • recordId (number) - идентификатор записи

  • messageId (number) - идентификатор сообщения

Запрос: (application/json)

{
  "text": "hello world",
  "mentions": [],
  "attachments": [],
  "replyMessageId": null
}

Ответ: 200 ОК

Удалить сообщение

URL: {domain}/api/v1/catalogs/{catalogId}/records/{recordId}/messages/{messageId}

Метод: DELETE

Параметры:

  • catalogId (number) — идентификатор каталога

  • recordId (number) - идентификатор записи

  • messageId (number) - идентификатор сообщения

Подписаться на сообщения в записи

URL: {domain}/api/v1/catalogs/{catalogId}/records/{recordId}/chatOptions/{recordId}

Метод: PATCH

Параметры:

  • catalogId (number) — идентификатор каталога

  • recordId (number) - идентификатор записи

Запрос: (application/json)

{
  "subscribe": true
}

Ответ: 200 OK (application/json)

{subscribe: true}
PreviousВиды (Views)NextАгрегация

Last updated 11 months ago

🔌