метод REST scope: imopenlines

imopenlines.config.add

Добавить открытую линию

Кто может выполнять: любой пользователь

Описание

Метод imopenlines.config.add добавляет новую открытую линию.

Чтобы пользователи могли писать в открытую линию, установите настройки коннектора методом imconnector.connector.data.set.

Параметры

PARAMS object необязательный

Объект с настройками открытой линии (подробное описание)

Параметр PARAMS

LINE_NAME string необязательный

Название открытой линии

ACTIVE char необязательный

Активность линии. Возможные значения:
- Y — линия активна
- N — линия неактивна

QUEUE array необязательный

Очередь операторов. Передается массив объектов с полями ENTITY_TYPE и ENTITY_ID.

Возможные значения:
- ENTITY_TYPE — пользователь user или подразделение department
- ENTITY_ID — идентификатор объекта выбранного типа. Для user указывается ID пользователя, для departmentID подразделения

Пример:

[
    {
        "ENTITY_TYPE":"user",
        "ENTITY_ID":"1"
    },
    {
        "ENTITY_TYPE":"department",
        "ENTITY_ID":"10"
    }
]
QUEUE_TYPE string необязательный

Режим распределения обращений. Возможные значения:
- evenly — равномерно распределять обращения между операторами
- strictly — направлять обращения строго по порядку очереди
- all — направлять обращение всем операторам очереди

QUEUE_TIME integer необязательный

Время в секундах до перехода обращения к следующему оператору

NO_ANSWER_TIME integer необязательный

Время в секундах до срабатывания сценария без ответа

WELCOME_MESSAGE char необязательный

Отправлять приветственное сообщение. Возможные значения:
- Y — да
- N — нет

WELCOME_MESSAGE_TEXT string необязательный

Текст приветственного сообщения

WORKTIME_ENABLE char необязательный

Учитывать рабочее время линии. Возможные значения:
- Y — да
- N — нет

WORKTIME_FROM string необязательный

Начало рабочего времени в формате HH:MM

WORKTIME_TO string необязательный

Окончание рабочего времени в формате HH:MM

WORKTIME_TIMEZONE string необязательный

Часовой пояс, например Europe/Kaliningrad

CRM char необязательный

Искать клиента в CRM. Возможные значения:
- Y — да
- N — нет

CRM_CREATE string необязательный

Что создавать в CRM для нового клиента

VOTE_MESSAGE char необязательный

Запрашивать оценку качества обслуживания. Возможные значения:
- Y — да
- N — нет

LANGUAGE_ID string необязательный

Язык линии, например ru

CRM_CREATE_SECOND string необязательный

Дополнительный режим создания элемента CRM

CRM_CREATE_THIRD char необязательный

Создавать третий элемент CRM. Возможные значения:
- Y — да
- N — нет

CRM_CHAT_TRACKER char необязательный

Включить чат-трекер для CRM. Возможные значения:
- Y — да
- N — нет

CRM_FORWARD char необязательный

Переводить обращение на ответственного по CRM. Возможные значения:
- Y — да
- N — нет

CRM_TRANSFER_CHANGE char необязательный

Менять ответственного в CRM при переводе диалога. Возможные значения:
- Y — да
- N — нет

CRM_SOURCE string необязательный

Источник для создаваемого элемента CRM

MAX_CHAT integer необязательный

Максимальное число одновременных диалогов у оператора

TYPE_MAX_CHAT string необязательный

Тип ограничения MAX_CHAT. Возможные значения:
- answered — учитывать только диалоги, в которых оператор уже ответил
- answered_new — учитывать диалоги с ответом и новые диалоги
- closed — учитывать закрытые диалоги

CATEGORY_ENABLE char необязательный

Включить категории. Возможные значения:
- Y — да
- N — нет

CATEGORY_ID integer необязательный

Идентификатор категории

SESSION_PRIORITY integer необязательный

Приоритет сессии в очереди

WELCOME_BOT_ENABLE char необязательный

Включить чат-бота приветствия. Возможные значения:
- Y — да
- N — нет

WELCOME_BOT_JOIN string необязательный

Когда подключать бота. Возможные значения:
- first — подключать бота только в начале диалога
- always — подключать бота в каждом диалоге

WELCOME_BOT_ID integer необязательный

Идентификатор чат-бота

WELCOME_BOT_TIME integer необязательный

Через сколько секунд переводить диалог от бота в очередь

WELCOME_BOT_LEFT string необязательный

Когда отключать бота. Возможные значения:
- queue — отключать бота при переводе в очередь операторов
- close — отключать бота при закрытии диалога

CHECK_AVAILABLE char необязательный

Проверять доступность оператора при распределении. Возможные значения:
- Y — да
- N — нет

WATCH_TYPING char необязательный

Показывать индикатор набора текста. Возможные значения:
- Y — да
- N — нет

SEND_WELCOME_EACH_SESSION char необязательный

Отправлять приветствие в каждой сессии. Возможные значения:
- Y — да
- N — нет

OPERATOR_DATA string необязательный

Формат данных об операторе. Возможные значения:
- profile — показывать профиль оператора
- queue — показывать данные оператора из очереди
- hide — скрывать данные оператора

DEFAULT_OPERATOR_DATA object необязательный

Данные оператора по умолчанию. Возможные поля:
- NAME — имя оператора
- AVATAR — ссылка на аватар оператора
- AVATAR_ID — идентификатор файла аватара

NO_ANSWER_RULE string необязательный

Сценарий, если оператор не ответил. Возможные значения:
- none — не выполнять сценарий
- text — отправить текстовое сообщение

NO_ANSWER_FORM_ID integer необязательный

Идентификатор CRM-формы для сценария без ответа

NO_ANSWER_BOT_ID integer необязательный

Идентификатор чат-бота для сценария без ответа

NO_ANSWER_TEXT string необязательный

Текст для сценария без ответа

WORKTIME_DAYOFF array необязательный

Выходные дни. Возможные значения элементов:
- MO — понедельник
- TU — вторник
- WE — среда
- TH — четверг
- FR — пятница
- SA — суббота
- SU — воскресенье

WORKTIME_HOLIDAYS string необязательный

Праздничные дни в формате строки, перечисленные через запятую DD.MM,DD.MM

WORKTIME_DAYOFF_RULE string необязательный

Сценарий в нерабочее время. Возможные значения:
- none — не выполнять сценарий
- text — отправить текстовое сообщение

WORKTIME_DAYOFF_FORM_ID integer необязательный

Идентификатор CRM-формы для нерабочего времени

WORKTIME_DAYOFF_BOT_ID integer необязательный

Идентификатор чат-бота для нерабочего времени

WORKTIME_DAYOFF_TEXT string необязательный

Текст сообщения в нерабочее время

CLOSE_RULE string необязательный

Сценарий при закрытии. Возможные значения:
- none — не выполнять сценарий
- text — отправить текстовое сообщение

CLOSE_FORM_ID integer необязательный

Идентификатор CRM-формы при закрытии

CLOSE_BOT_ID integer необязательный

Идентификатор чат-бота при закрытии

CLOSE_TEXT string необязательный

Текст сообщения при закрытии

VOTE_TIME_LIMIT integer необязательный

Лимит времени на голосование

VOTE_CLOSING_DELAY char необязательный

Закрывать сессию сразу после оценки. Возможные значения:
- Y — да
- N — нет

VOTE_BEFORE_FINISH char необязательный

Запрашивать оценку до завершения. Возможные значения:
- Y — да
- N — нет

VOTE_MESSAGE_1_TEXT string необязательный

Текст запроса оценки в виджете

VOTE_MESSAGE_1_LIKE string необязательный

Текст после положительной оценки в виджете

VOTE_MESSAGE_1_DISLIKE string необязательный

Текст после отрицательной оценки в виджете

VOTE_MESSAGE_2_TEXT string необязательный

Текст запроса оценки в внешних каналах

VOTE_MESSAGE_2_LIKE string необязательный

Текст после положительной оценки в внешних каналах

VOTE_MESSAGE_2_DISLIKE string необязательный

Текст после отрицательной оценки в внешних каналах

AUTO_CLOSE_RULE string необязательный

Сценарий автозакрытия. Возможные значения:
- none — не выполнять сценарий
- text — отправить текстовое сообщение

FULL_CLOSE_TIME integer необязательный

Время полного закрытия после ручного закрытия

AUTO_CLOSE_TIME integer необязательный

Время до автозакрытия

AUTO_CLOSE_FORM_ID integer необязательный

Идентификатор CRM-формы для автозакрытия

AUTO_CLOSE_BOT_ID integer необязательный

Идентификатор чат-бота для автозакрытия

AUTO_CLOSE_TEXT string необязательный

Текст при автозакрытии

AUTO_EXPIRE_TIME integer необязательный

Срок жизни автоматически закрытой сессии

TEMPORARY char необязательный

Создать временную линию. Возможные значения:
- Y — создать временную линию
- N — создать постоянную линию

QUICK_ANSWERS_IBLOCK_ID integer необязательный

Идентификатор инфоблока быстрых ответов

KPI_FIRST_ANSWER_TIME integer необязательный

Контроль времени первого ответа

KPI_FIRST_ANSWER_ALERT char необязательный

Включить уведомление о первом ответе. Возможные значения:
- Y — да
- N — нет

KPI_FIRST_ANSWER_LIST array необязательный

Список получателей уведомления о первом ответе

KPI_FIRST_ANSWER_TEXT string необязательный

Текст уведомления о первом ответе

KPI_FURTHER_ANSWER_TIME integer необязательный

Контроль времени последующих ответов

KPI_FURTHER_ANSWER_ALERT char необязательный

Включить уведомление о последующих ответах. Возможные значения:
- Y — да
- N — нет

KPI_FURTHER_ANSWER_LIST array необязательный

Список получателей уведомления о последующих ответах

KPI_FURTHER_ANSWER_TEXT string необязательный

Текст уведомления о последующих ответах

KPI_CHECK_OPERATOR_ACTIVITY char необязательный

Контролировать активность оператора. Возможные значения:
- Y — да
- N — нет

USE_WELCOME_FORM char необязательный

Использовать приветственную CRM-форму. Возможные значения:
- Y — да
- N — нет

WELCOME_FORM_ID integer необязательный

Идентификатор приветственной CRM-формы

WELCOME_FORM_DELAY char необязательный

Показывать форму с задержкой. Возможные значения:
- Y — да
- N — нет

CONFIRM_CLOSE char необязательный

Запрашивать подтверждение закрытия. Возможные значения:
- Y — да
- N — нет

IGNORE_WELCOME_FORM_RESPONSIBLE char необязательный

Игнорировать ответственного в приветственной форме. Возможные значения:
- Y — да
- N — нет

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "PARAMS": {
      "LINE_NAME": "Линия поддержки интернет-магазина",
      "QUEUE": [
        {
          "ENTITY_TYPE": "user",
          "ENTITY_ID": "1"
        },
        {
          "ENTITY_TYPE": "user",
          "ENTITY_ID": "15"
        },
        {
          "ENTITY_TYPE": "user",
          "ENTITY_ID": "23"
        }
      ],
      "QUEUE_TYPE": "strictly",
      "QUEUE_TIME": 45,
      "NO_ANSWER_TIME": 120,
      "WELCOME_MESSAGE": "Y",
      "WELCOME_MESSAGE_TEXT": "Здравствуйте! Ответим в течение пары минут",
      "CRM": "Y",
      "CRM_CREATE": "deal",
      "CRM_SOURCE": "openline_web",
      "CRM_FORWARD": "Y",
      "MAX_CHAT": 4,
      "TYPE_MAX_CHAT": "answered_new",
      "WORKTIME_ENABLE": "Y",
      "WORKTIME_FROM": "09:00",
      "WORKTIME_TO": "21:00",
      "WORKTIME_TIMEZONE": "Europe/Kaliningrad",
      "WORKTIME_DAYOFF": [
        "SA",
        "SU"
      ],
      "WORKTIME_DAYOFF_RULE": "text",
      "WORKTIME_DAYOFF_TEXT": "Сейчас линия не работает. Напишите, и мы ответим в рабочее время"
    }
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.config.add

Ответ

HTTP-статус: 200

{
    "result": 15,
    "time": {
        "start": 1741688359.737944,
        "finish": 1741688360.028349,
        "duration": 0.2904050350189209,
        "processing": 0.16270899772644043,
        "date_start": "2025-03-11T10:25:59+03:00",
        "date_finish": "2025-03-11T10:26:00+03:00",
        "operating_reset_at": 1741688960,
        "operating": 0
    }
}

Возвращаемые данные

result integer

Идентификатор созданной открытой линии

time time

Информация о времени выполнения запроса

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.