Бипуим: Документация
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. Методы интеграции
  3. Примеры интеграций
  4. Телефония
  5. Oktell

Компонент Bpium в Oktell

PreviousПанель телефонии OktellNext1C

Last updated 6 years ago

Компонент доступен в Oktell начиная с версии 2.13 от 23.12.2015.

Компонент сценария

В коммуникационную платформу Oktell встроен мощный механизм пользовательских скриптов — сценариев. Они выполняют различные действия при внешних событиях или по расписанию. Сценарии состоят из связанных компонентов, каждый из которых имеет свойства. Благодаря простой настройке сценариев в графическом редакторе, провести интеграцию сможет любой штатный специалист компании.

В сценариях Oktell несколько десятков компонентов: логических операций, компонентов для работы с телефонией, почтой, месенджерами, базами данных и файловой системой. Один из компонентов — «Запрос к Bpium».

Возможности компонента

Компонент позволяет работать с записями в Бипиуме:

  • находить записи с определёнными свойствами

  • получать конкретные записи по номеру

  • создавать новые записи

  • изменять записи

  • удалять записи

Включение интеграции

Прежде чем начать использовать компонент в сценариях, настройте соединение Oktell с Бипиумом. Зайдите в общие настройки Oktell и укажите адрес вашего домена в Bpium, электронную почту и пароль пользователя, под которым Oktell будет обращаться к Бипиуму. Перед этим добавьте пользователя в качестве сотрудника в Бипиуме, или введите ваши авторизационные данные.

После авторизации Oktell запросит у Бипиума структуру данных: секции, каталоги и виды. Если вы измените структуру данных в Бипиуме, то Oktell её обновит спустя несколько часов. Чтобы провести принудительную синхронизацию нажмите кнопку:

Свойства компонента Bpium

Объект: запись

Работа с записями каталогов.

Метод: Найти запись

Находит и возвращает одну доступную запись, удовлетворяющую условиям поиска. Если требуется вернуть несколько — организуйте цикл в сценариях.

Раздел «Запрос»

  • Секция: список доступных отделов в Бипиуме.

  • Каталог: список доступных каталогов выбранного отдела.

  • Вид: список доступных видов выбранного каталога.

  • Сортировать по: поле каталога, по которому будет произведена сортировка.

  • Очередность: порядок сортировки.

  • Содержит текст: быстрый поиск по текстовым полям каталога.

  • Режим фильтра: список установленных фильтров:

    • Без фильтра — не использовать фильтр

    • Значение полей — включает режим задания фильтров в форме в свойстве «Условия фильтра»

    • GET-параметры — расширенное задание фильтров согласно API

  • Условия фильтра: форма для установки значений фильтра по полям каталога.

  • Порядковый номер: номер записи в выборке, которую нужно вернуть. Используется для получения записей в цикле. по умолчанию возвращает первую (нулевую) запись.

  • Сохранение полей: форма для назначения в какие переменные сценария сохранить значения полей записи.

Раздел «Подключение»

  • Таймаут: время ожидания ответа. Если Бипиум не ответит за указанное время, компонент продолжит работу сценария по ветке таймаут. Измеряется в секундах.

Раздел «Результат»

  • Ответ в переменную: запись в JSON-формате согласно API (метод Record/GET). Для получения значений полей записи используйте компонент сценариев «Парсер».

  • Код ошибки в переменную: возврат кода ошибки, в случае её возникновения

  • Переход: указание компонента, к которому перейдёт сценарий в случае успешного выполнения запроса.

  • Переход, таймаут: указание компонента, к которому перейдёт сценарий в случае не выполнения запроса по таймауту.

  • Переход, ошибка: указание компонента, к которому перейдёт сценарий в случае не выполнения запроса по ошибке.

Метод: Получить структуру записи

Возвращает метаданные каталога: описание структуры полей и возможных значений.

Раздел «Запрос»

  • Секция: список доступных отделов в Бипиуме.

  • Каталог: список доступных каталогов выбранного отдела.

Раздел «Результат»

  • Ответ в переменную: список полей каталога в JSON-формате согласно API (метод Catalog/GET). Для получения структуры отдельных полей и их свойств используйте компонент сценариев «Парсер».

Остальные параметры идентичны запросу метода «Найти запись».

Метод: Получить запись

Возвращает запись по её идентификатору.

Раздел «Запрос»

  • Секция: список доступных отделов в Бипиуме.

  • Каталог: список доступных каталогов выбранного отдела.

  • ID записи: идентификатор (ID) записи в Бипиуме.

  • Сохранение полей: форма для назначения в какие переменные сценария сохранить значения полей записи.

Раздел «Результат»

  • Ответ в переменную: запись в JSON-формате согласно API (метод Record/GET). Для получения значений полей записи используйте компонент сценариев «Парсер».

Остальные параметры идентичны запросу метода «Найти запись».

Метод: Изменить запись

Изменяет запись по её идентификатору.

Раздел «Запрос»

  • Секция: список доступных отделов в Бипиуме.

  • Каталог: список доступных каталогов выбранного отдела.

  • ID записи: идентификатор (ID) записи в Бипиуме.

  • Режим задания свойств: способ передачи значения полей:

    • Значения полей — назначение значений через форму в свойстве «Поля»

    • JSON-объект — передача значений через JSON согласно API

  • Поля: форма для назначения значений полей из переменных. Если у поля не стоит галочка, то значение поля не будет изменено при сохранении.

  • Данные записи (JSON): расширенный способ передачи значений полей через JSON-структуру согласно API.

Раздел «Результат»

  • Ответ в переменную: ответ на запрос в JSON-формате согласно API (метод Record/PATCH).

Остальные параметры идентичны запросу метода «Найти запись».

Метод: Добавить запись

Создает новую запись в каталоге.

Раздел «Результат»

  • ID записи в переменную: возвращает идентификатор (ID) созданной записи в случае успеха.

  • Ответ в переменную: ответ на запрос в JSON-формате согласно API (метод Record/POST).

Остальные параметры идентичны запросу метода «Изменить запись».

Метод: Удалить запись

Удаляет запись по её идентификатору.

Раздел «Запрос»

  • Секция: список доступных отделов в Бипиуме.

  • Каталог: список доступных каталогов выбранного отдела.

  • ID записи: идентификатор (ID) записи в Бипиуме.

Раздел «Результат»

  • Ответ в переменную: ответ на запрос в JSON-формате согласно API (метод Record/DELETE).

Остальные параметры идентичны запросу метода «Найти запись».

Формат указания домена: вашдомен.bpium.ru, либо полный адрес с указанием протокола и порта: .

🥂
https://вашдомен.ru