Получить открытую линию по идентификатору imopenlines.config.get

Scope: imopenlines

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

Метод imopenlines.config.get получает настройки открытой линии по идентификатору.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

CONFIG_ID*
integer

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

Получить идентификатор открытой линии можно при создании открытой линии или методом получения списка открытых линий

WITH_QUEUE
char

Возвращать данные очереди операторов. Возможные значения:

  • Y — да
  • N — нет

SHOW_OFFLINE
char

Возвращать офлайн-операторов в очереди. Возможные значения:

  • Y — да
  • N — нет

Примеры кода

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "CONFIG_ID": 15,
            "WITH_QUEUE": "Y",
            "SHOW_OFFLINE": "Y"
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.config.get
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "CONFIG_ID": 15,
            "WITH_QUEUE": "Y",
            "SHOW_OFFLINE": "Y",
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imopenlines.config.get
        
try
        {
            const response = await $b24.callMethod(
                'imopenlines.config.get',
                {
                    CONFIG_ID: 15,
                    WITH_QUEUE: 'Y',
                    SHOW_OFFLINE: 'Y'
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.config.get',
                    [
                        'CONFIG_ID' => 15,
                        'WITH_QUEUE' => 'Y',
                        'SHOW_OFFLINE' => 'Y',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'imopenlines.config.get',
            {
                CONFIG_ID: 15,
                WITH_QUEUE: 'Y',
                SHOW_OFFLINE: 'Y'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.config.get',
            [
                'CONFIG_ID' => 15,
                'WITH_QUEUE' => 'Y',
                'SHOW_OFFLINE' => 'Y',
            ]
        );
        
        print_r($result);
        

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "ID": "22",
                "ACTIVE": "Y",
                "LINE_NAME": "Документация Битрикс24",
                "CRM": "N",
                "CRM_CREATE": "lead",
                "CRM_CREATE_SECOND": "0",
                "CRM_CREATE_THIRD": "Y",
                "CRM_FORWARD": "Y",
                "CRM_CHAT_TRACKER": "N",
                "CRM_TRANSFER_CHANGE": "Y",
                "CRM_SOURCE": "create",
                "QUEUE_TIME": "60",
                "NO_ANSWER_TIME": "60",
                "QUEUE_TYPE": "evenly",
                "CHECK_AVAILABLE": "Y",
                "WATCH_TYPING": "N",
                "WELCOME_BOT_ENABLE": "Y",
                "WELCOME_MESSAGE": "N",
                "WELCOME_MESSAGE_TEXT": "Добро пожаловать в открытую линию [b]«Документация Битрикс24»[/b][br]Вам ответит первый освободившийся оператор.",
                "VOTE_MESSAGE": "Y",
                "VOTE_TIME_LIMIT": "0",
                "VOTE_BEFORE_FINISH": "Y",
                "VOTE_CLOSING_DELAY": "Y",
                "VOTE_MESSAGE_1_TEXT": "Пожалуйста, оцените качество обслуживания.",
                "VOTE_MESSAGE_1_LIKE": "Спасибо за оценку!",
                "VOTE_MESSAGE_1_DISLIKE": "Очень жаль, что мы не смогли помочь вам, мы постараемся стать лучше.",
                "VOTE_MESSAGE_2_TEXT": "Пожалуйста, оцените качество обслуживания.\r\n\r\nОтправьте: 1 - хорошо, 0 - плохо",
                "VOTE_MESSAGE_2_LIKE": "Спасибо за оценку!",
                "VOTE_MESSAGE_2_DISLIKE": "Очень жаль, что мы не смогли помочь вам, мы постараемся стать лучше.",
                "AGREEMENT_MESSAGE": "N",
                "AGREEMENT_ID": "0",
                "CATEGORY_ENABLE": "N",
                "CATEGORY_ID": "0",
                "WELCOME_BOT_JOIN": "always",
                "WELCOME_BOT_ID": "597",
                "WELCOME_BOT_TIME": "180",
                "WELCOME_BOT_LEFT": "close",
                "NO_ANSWER_RULE": "text",
                "NO_ANSWER_FORM_ID": "0",
                "NO_ANSWER_BOT_ID": "0",
                "NO_ANSWER_TEXT": "К сожалению, в данный момент мы не можем вам ответить, мы обязательно с вами свяжемся.",
                "WORKTIME_ENABLE": "Y",
                "WORKTIME_FROM": "0",
                "WORKTIME_TO": "23.59",
                "WORKTIME_TIMEZONE": "Europe/Kaliningrad",
                "WORKTIME_HOLIDAYS": [
                    ""
                ],
                "WORKTIME_DAYOFF": [
                    ""
                ],
                "WORKTIME_DAYOFF_RULE": "text",
                "WORKTIME_DAYOFF_FORM_ID": "0",
                "WORKTIME_DAYOFF_BOT_ID": "0",
                "WORKTIME_DAYOFF_TEXT": "К сожалению, в данный момент мы не можем вам ответить.[br][br]Напишите свой вопрос и мы обязательно свяжемся с вами в рабочее время.",
                "CLOSE_RULE": "text",
                "CLOSE_FORM_ID": "0",
                "CLOSE_BOT_ID": "0",
                "CLOSE_TEXT": "Спасибо, что обратились к нам, пожалуйста, оцените качество обслуживания.",
                "FULL_CLOSE_TIME": "0",
                "AUTO_CLOSE_RULE": "none",
                "AUTO_CLOSE_FORM_ID": "0",
                "AUTO_CLOSE_BOT_ID": "0",
                "AUTO_CLOSE_TIME": "3600",
                "AUTO_CLOSE_TEXT": "",
                "AUTO_EXPIRE_TIME": "86400",
                "DATE_CREATE": {},
                "DATE_MODIFY": {},
                "MODIFY_USER_ID": "27",
                "TEMPORARY": "N",
                "XML_ID": null,
                "LANGUAGE_ID": "ru",
                "QUICK_ANSWERS_IBLOCK_ID": "181",
                "SESSION_PRIORITY": "0",
                "TYPE_MAX_CHAT": "answered_new",
                "MAX_CHAT": "0",
                "OPERATOR_DATA": "profile",
                "DEFAULT_OPERATOR_DATA": [],
                "KPI_FIRST_ANSWER_TIME": "0",
                "KPI_FIRST_ANSWER_ALERT": "N",
                "KPI_FIRST_ANSWER_LIST": null,
                "KPI_FIRST_ANSWER_TEXT": "Сотрудник #OPERATOR# превысил допустимое время ответа клиенту на первое сообщение. Диалог №#DIALOG#.",
                "KPI_FURTHER_ANSWER_TIME": "0",
                "KPI_FURTHER_ANSWER_ALERT": "N",
                "KPI_FURTHER_ANSWER_LIST": null,
                "KPI_FURTHER_ANSWER_TEXT": "Сотрудник #OPERATOR# превысил допустимое время ответа клиенту на сообщение. Диалог №#DIALOG#.",
                "KPI_CHECK_OPERATOR_ACTIVITY": "N",
                "SEND_NOTIFICATION_EMPTY_QUEUE": "N",
                "USE_WELCOME_FORM": "N",
                "WELCOME_FORM_ID": "111",
                "WELCOME_FORM_DELAY": "Y",
                "SEND_WELCOME_EACH_SESSION": "Y",
                "CONFIRM_CLOSE": "Y",
                "IGNORE_WELCOME_FORM_RESPONSIBLE": "N",
                "QUEUE": [
                    "27",
                    "103"
                ],
                "QUEUE_FULL": {
                    "27": {
                        "ID": "245",
                        "SORT": "0",
                        "USER_ID": "27",
                        "DEPARTMENT_ID": "0",
                        "USER_NAME": null,
                        "USER_WORK_POSITION": null,
                        "USER_AVATAR": null,
                        "USER_AVATAR_ID": "0"
                    },
                    "103": {
                        "ID": "251",
                        "SORT": "1",
                        "USER_ID": "103",
                        "DEPARTMENT_ID": "0",
                        "USER_NAME": null,
                        "USER_WORK_POSITION": null,
                        "USER_AVATAR": null,
                        "USER_AVATAR_ID": "0"
                    }
                },
                "QUEUE_USERS_FIELDS": {
                    "27": {
                        "USER_NAME": null,
                        "USER_WORK_POSITION": null,
                        "USER_AVATAR": null,
                        "USER_AVATAR_ID": "0"
                    },
                    "103": {
                        "USER_NAME": null,
                        "USER_WORK_POSITION": null,
                        "USER_AVATAR": null,
                        "USER_AVATAR_ID": "0"
                    }
                },
                "QUEUE_ONLINE": "Y"
            },
            "time": {
                "start": 1773663905,
                "finish": 1773663905.742784,
                "duration": 0.7427840232849121,
                "processing": 0,
                "date_start": "2026-03-16T15:25:05+03:00",
                "date_finish": "2026-03-16T15:25:05+03:00",
                "operating_reset_at": 1773664505,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
object

Значение результата. Возможные значения:

  • object — объект с настройками открытой линии (подробное описание)
  • false — линия с указанным CONFIG_ID не существует

time
time

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

Объект result

Название
тип

Описание

ID
string

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

LINE_NAME
string

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

ACTIVE
string

Признак активности линии. Возможные значения:

  • Y — линия активна
  • N — линия неактивна

CRM
string

Признак работы с CRM. Возможные значения:

  • Y — да
  • N — нет

CRM_CREATE
string

Сценарий создания элемента CRM

CRM_CREATE_SECOND
string

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

CRM_CREATE_THIRD
string

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

  • Y — да
  • N — нет

CRM_FORWARD
string

Признак перенаправления в CRM. Возможные значения:

  • Y — да
  • N — нет

CRM_CHAT_TRACKER
string

Признак отправки диалога в трекер CRM. Возможные значения:

  • Y — да
  • N — нет

CRM_TRANSFER_CHANGE
string

Признак смены ответственного при переводе. Возможные значения:

  • Y — да
  • N — нет

CRM_SOURCE
string

Режим работы с источником в CRM

QUEUE_TYPE
string

Режим распределения обращений

QUEUE_TIME
string

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

NO_ANSWER_TIME
string

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

CHECK_AVAILABLE
string

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

  • Y — да
  • N — нет

WATCH_TYPING
string

Показывать набор текста оператором. Возможные значения:

  • Y — да
  • N — нет

WELCOME_BOT_ENABLE
string

Признак использования приветственного бота. Возможные значения:

  • Y — да
  • N — нет

WELCOME_MESSAGE
string

Признак приветственного сообщения. Возможные значения:

  • Y — да
  • N — нет

WELCOME_MESSAGE_TEXT
string

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

VOTE_MESSAGE
string

Признак запроса оценки. Возможные значения:

  • Y — да
  • N — нет

VOTE_TIME_LIMIT
string

Ограничение времени для оценки

VOTE_BEFORE_FINISH
string

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

  • Y — да
  • N — нет

VOTE_CLOSING_DELAY
string

Использовать задержку закрытия после оценки. Возможные значения:

  • 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

Текст при отрицательной оценке по второму сценарию

AGREEMENT_MESSAGE
string

Признак вывода сообщения о согласии. Возможные значения:

  • Y — да
  • N — нет

AGREEMENT_ID
string

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

CATEGORY_ENABLE
string

Признак использования категорий. Возможные значения:

  • Y — да
  • N — нет

CATEGORY_ID
string

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

WELCOME_BOT_JOIN
string

Режим подключения приветственного бота

WELCOME_BOT_ID
string

Идентификатор приветственного бота

WELCOME_BOT_TIME
string

Время ожидания подключения приветственного бота

WELCOME_BOT_LEFT
string

Режим отключения приветственного бота

NO_ANSWER_RULE
string

Сценарий при отсутствии ответа оператора

NO_ANSWER_FORM_ID
string

Идентификатор формы сценария отсутствия ответа

NO_ANSWER_BOT_ID
string

Идентификатор бота сценария отсутствия ответа

NO_ANSWER_TEXT
string

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

WORKTIME_ENABLE
string

Признак учета рабочего времени. Возможные значения:

  • Y — да
  • N — нет

WORKTIME_FROM
string

Начало рабочего времени

WORKTIME_TO
string

Конец рабочего времени

WORKTIME_TIMEZONE
string

Часовой пояс рабочего времени

WORKTIME_HOLIDAYS
array

Массив праздничных дней

WORKTIME_DAYOFF
array

Массив выходных дней

WORKTIME_DAYOFF_RULE
string

Сценарий обработки обращений в нерабочее время

WORKTIME_DAYOFF_FORM_ID
string

Идентификатор формы сценария нерабочего времени

WORKTIME_DAYOFF_BOT_ID
string

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

WORKTIME_DAYOFF_TEXT
string

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

CLOSE_RULE
string

Сценарий закрытия диалога

CLOSE_FORM_ID
string

Идентификатор формы закрытия

CLOSE_BOT_ID
string

Идентификатор бота закрытия

CLOSE_TEXT
string

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

FULL_CLOSE_TIME
string

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

AUTO_CLOSE_RULE
string

Сценарий автозакрытия

AUTO_CLOSE_FORM_ID
string

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

AUTO_CLOSE_BOT_ID
string

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

AUTO_CLOSE_TIME
string

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

AUTO_CLOSE_TEXT
string

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

AUTO_EXPIRE_TIME
string

Время истечения активности

DATE_CREATE
object

Дата создания настройки в сериализованном виде

DATE_MODIFY
object

Дата изменения настройки в сериализованном виде

MODIFY_USER_ID
string

Идентификатор пользователя, изменившего настройки

TEMPORARY
string

Признак временной линии. Возможные значения:

  • Y — временная линия
  • N — постоянная линия

XML_ID
string

Внешний идентификатор. Возможные значения:

  • string — внешний идентификатор задан
  • null — внешний идентификатор не задан

LANGUAGE_ID
string

Язык линии

QUICK_ANSWERS_IBLOCK_ID
string

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

SESSION_PRIORITY
string

Приоритет сессии

TYPE_MAX_CHAT
string

Режим ограничения активных диалогов на оператора

MAX_CHAT
string

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

OPERATOR_DATA
string

Режим отображения данных оператора

QUEUE
array

Идентификаторы операторов в очереди

QUEUE_FULL
object

Данные элементов очереди. Ключ объекта — идентификатор пользователя, значение — очередь (подробное описание)

QUEUE_USERS_FIELDS
object

Поля пользователей очереди. Ключ объекта — идентификатор пользователя, значение — описание пользователя (подробное описание)

QUEUE_ONLINE
string

Признак проверки онлайна операторов. Возможные значения:

  • Y — да
  • N — нет

DEFAULT_OPERATOR_DATA
array

Набор полей отображения оператора по умолчанию

KPI_FIRST_ANSWER_TIME
string

Норматив времени первого ответа

KPI_FIRST_ANSWER_ALERT
string

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

  • Y — да
  • N — нет

KPI_FIRST_ANSWER_LIST
array

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

  • array — список получателей задан
  • null — список получателей не задан

KPI_FIRST_ANSWER_TEXT
string

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

KPI_FURTHER_ANSWER_TIME
string

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

KPI_FURTHER_ANSWER_ALERT
string

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

  • Y — да
  • N — нет

KPI_FURTHER_ANSWER_LIST
array

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

  • array — список получателей задан
  • null — список получателей не задан

KPI_FURTHER_ANSWER_TEXT
string

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

KPI_CHECK_OPERATOR_ACTIVITY
string

Признак контроля активности оператора. Возможные значения:

  • Y — да
  • N — нет

SEND_NOTIFICATION_EMPTY_QUEUE
string

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

  • Y — да
  • N — нет

USE_WELCOME_FORM
string

Признак использования приветственной формы. Возможные значения:

  • Y — да
  • N — нет

WELCOME_FORM_ID
string

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

WELCOME_FORM_DELAY
string

Признак задержки показа приветственной формы. Возможные значения:

  • Y — да
  • N — нет

SEND_WELCOME_EACH_SESSION
string

Показывать приветствие в каждой сессии. Возможные значения:

  • Y — да
  • N — нет

CONFIRM_CLOSE
string

Требовать подтверждение закрытия. Возможные значения:

  • Y — да
  • N — нет

IGNORE_WELCOME_FORM_RESPONSIBLE
string

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

  • Y — да
  • N — нет

Объект QUEUE_FULL

Название
тип

Описание

ID
string

Идентификатор записи элемента очереди

SORT
string

Позиция в очереди

USER_ID
string

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

DEPARTMENT_ID
string

Идентификатор подразделения

USER_NAME
string

Имя пользователя. Возможные значения:

  • string — имя пользователя задано
  • null — имя пользователя не задано

USER_WORK_POSITION
string

Должность пользователя. Возможные значения:

  • string — должность задана
  • null — должность не задана

USER_AVATAR
string

Ссылка на аватар. Возможные значения:

  • string — ссылка на аватар задана
  • null — аватар не задан

USER_AVATAR_ID
string

Идентификатор файла аватара

Объект QUEUE_USERS_FIELDS

Название
тип

Описание

USER_NAME
string

Имя пользователя. Возможные значения:

  • string — имя пользователя задано
  • null — имя пользователя не задано

USER_WORK_POSITION
string

Должность пользователя. Возможные значения:

  • string — должность задана
  • null — должность не задана

USER_AVATAR
string

Ссылка на аватар. Возможные значения:

  • string — ссылка на аватар задана
  • null — аватар не задан

USER_AVATAR_ID
string

Идентификатор файла аватара

Обработка ошибок

HTTP-статус: 400

{
            "error": "CONFIG_ID_EMPTY",
            "error_description": "Config ID can't be empty"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус

Код

Описание

Значение

400

CONFIG_ID_EMPTY

Config ID can't be empty

Параметр CONFIG_ID не передан или передан некорректно

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение