Получить открытую линию по идентификатору imopenlines.config.get
Scope:
imopenlinesКто может выполнять метод: любой пользователь
Метод imopenlines.config.get получает настройки открытой линии по идентификатору.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
CONFIG_ID* |
Идентификатор открытой линии. Получить идентификатор открытой линии можно при создании открытой линии или методом получения списка открытых линий |
|
WITH_QUEUE |
Возвращать данные очереди операторов. Возможные значения:
|
|
SHOW_OFFLINE |
Возвращать офлайн-операторов в очереди. Возможные значения:
|
Примеры кода
Как использовать примеры в документации
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 |
Значение результата. Возможные значения:
|
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
ID |
Идентификатор открытой линии |
|
LINE_NAME |
Название открытой линии |
|
ACTIVE |
Признак активности линии. Возможные значения:
|
|
CRM |
Признак работы с CRM. Возможные значения:
|
|
CRM_CREATE |
Сценарий создания элемента CRM |
|
CRM_CREATE_SECOND |
Дополнительный режим создания элемента CRM |
|
CRM_CREATE_THIRD |
Дополнительный режим создания элемента CRM. Возможные значения:
|
|
CRM_FORWARD |
Признак перенаправления в CRM. Возможные значения:
|
|
CRM_CHAT_TRACKER |
Признак отправки диалога в трекер CRM. Возможные значения:
|
|
CRM_TRANSFER_CHANGE |
Признак смены ответственного при переводе. Возможные значения:
|
|
CRM_SOURCE |
Режим работы с источником в CRM |
|
QUEUE_TYPE |
Режим распределения обращений |
|
QUEUE_TIME |
Время перехода обращения к следующему оператору |
|
NO_ANSWER_TIME |
Время до срабатывания сценария без ответа |
|
CHECK_AVAILABLE |
Проверять доступность операторов. Возможные значения:
|
|
WATCH_TYPING |
Показывать набор текста оператором. Возможные значения:
|
|
WELCOME_BOT_ENABLE |
Признак использования приветственного бота. Возможные значения:
|
|
WELCOME_MESSAGE |
Признак приветственного сообщения. Возможные значения:
|
|
WELCOME_MESSAGE_TEXT |
Текст приветственного сообщения |
|
VOTE_MESSAGE |
Признак запроса оценки. Возможные значения:
|
|
VOTE_TIME_LIMIT |
Ограничение времени для оценки |
|
VOTE_BEFORE_FINISH |
Запрашивать оценку до завершения диалога. Возможные значения:
|
|
VOTE_CLOSING_DELAY |
Использовать задержку закрытия после оценки. Возможные значения:
|
|
VOTE_MESSAGE_1_TEXT |
Текст первого сценария оценки |
|
VOTE_MESSAGE_1_LIKE |
Текст при положительной оценке по первому сценарию |
|
VOTE_MESSAGE_1_DISLIKE |
Текст при отрицательной оценке по первому сценарию |
|
VOTE_MESSAGE_2_TEXT |
Текст второго сценария оценки |
|
VOTE_MESSAGE_2_LIKE |
Текст при положительной оценке по второму сценарию |
|
VOTE_MESSAGE_2_DISLIKE |
Текст при отрицательной оценке по второму сценарию |
|
AGREEMENT_MESSAGE |
Признак вывода сообщения о согласии. Возможные значения:
|
|
AGREEMENT_ID |
Идентификатор согласия |
|
CATEGORY_ENABLE |
Признак использования категорий. Возможные значения:
|
|
CATEGORY_ID |
Идентификатор категории |
|
WELCOME_BOT_JOIN |
Режим подключения приветственного бота |
|
WELCOME_BOT_ID |
Идентификатор приветственного бота |
|
WELCOME_BOT_TIME |
Время ожидания подключения приветственного бота |
|
WELCOME_BOT_LEFT |
Режим отключения приветственного бота |
|
NO_ANSWER_RULE |
Сценарий при отсутствии ответа оператора |
|
NO_ANSWER_FORM_ID |
Идентификатор формы сценария отсутствия ответа |
|
NO_ANSWER_BOT_ID |
Идентификатор бота сценария отсутствия ответа |
|
NO_ANSWER_TEXT |
Текст сообщения при отсутствии ответа |
|
WORKTIME_ENABLE |
Признак учета рабочего времени. Возможные значения:
|
|
WORKTIME_FROM |
Начало рабочего времени |
|
WORKTIME_TO |
Конец рабочего времени |
|
WORKTIME_TIMEZONE |
Часовой пояс рабочего времени |
|
WORKTIME_HOLIDAYS |
Массив праздничных дней |
|
WORKTIME_DAYOFF |
Массив выходных дней |
|
WORKTIME_DAYOFF_RULE |
Сценарий обработки обращений в нерабочее время |
|
WORKTIME_DAYOFF_FORM_ID |
Идентификатор формы сценария нерабочего времени |
|
WORKTIME_DAYOFF_BOT_ID |
Идентификатор бота сценария нерабочего времени |
|
WORKTIME_DAYOFF_TEXT |
Текст сообщения в нерабочее время |
|
CLOSE_RULE |
Сценарий закрытия диалога |
|
CLOSE_FORM_ID |
Идентификатор формы закрытия |
|
CLOSE_BOT_ID |
Идентификатор бота закрытия |
|
CLOSE_TEXT |
Текст сообщения при закрытии |
|
FULL_CLOSE_TIME |
Время полного закрытия сессии |
|
AUTO_CLOSE_RULE |
Сценарий автозакрытия |
|
AUTO_CLOSE_FORM_ID |
Идентификатор формы автозакрытия |
|
AUTO_CLOSE_BOT_ID |
Идентификатор бота автозакрытия |
|
AUTO_CLOSE_TIME |
Время до автозакрытия |
|
AUTO_CLOSE_TEXT |
Текст автозакрытия |
|
AUTO_EXPIRE_TIME |
Время истечения активности |
|
DATE_CREATE |
Дата создания настройки в сериализованном виде |
|
DATE_MODIFY |
Дата изменения настройки в сериализованном виде |
|
MODIFY_USER_ID |
Идентификатор пользователя, изменившего настройки |
|
TEMPORARY |
Признак временной линии. Возможные значения:
|
|
XML_ID |
Внешний идентификатор. Возможные значения:
|
|
LANGUAGE_ID |
Язык линии |
|
QUICK_ANSWERS_IBLOCK_ID |
Идентификатор инфоблока быстрых ответов |
|
SESSION_PRIORITY |
Приоритет сессии |
|
TYPE_MAX_CHAT |
Режим ограничения активных диалогов на оператора |
|
MAX_CHAT |
Максимум активных диалогов на оператора |
|
OPERATOR_DATA |
Режим отображения данных оператора |
|
QUEUE |
Идентификаторы операторов в очереди |
|
QUEUE_FULL |
Данные элементов очереди. Ключ объекта — идентификатор пользователя, значение — очередь (подробное описание) |
|
QUEUE_USERS_FIELDS |
Поля пользователей очереди. Ключ объекта — идентификатор пользователя, значение — описание пользователя (подробное описание) |
|
QUEUE_ONLINE |
Признак проверки онлайна операторов. Возможные значения:
|
|
DEFAULT_OPERATOR_DATA |
Набор полей отображения оператора по умолчанию |
|
KPI_FIRST_ANSWER_TIME |
Норматив времени первого ответа |
|
KPI_FIRST_ANSWER_ALERT |
Признак уведомления о просрочке первого ответа. Возможные значения:
|
|
KPI_FIRST_ANSWER_LIST |
Список получателей уведомлений о первом ответе. Возможные значения:
|
|
KPI_FIRST_ANSWER_TEXT |
Текст уведомления о просрочке первого ответа |
|
KPI_FURTHER_ANSWER_TIME |
Норматив времени последующих ответов |
|
KPI_FURTHER_ANSWER_ALERT |
Признак уведомления о просрочке последующих ответов. Возможные значения:
|
|
KPI_FURTHER_ANSWER_LIST |
Список получателей уведомлений о последующих ответах. Возможные значения:
|
|
KPI_FURTHER_ANSWER_TEXT |
Текст уведомления о просрочке последующих ответов |
|
KPI_CHECK_OPERATOR_ACTIVITY |
Признак контроля активности оператора. Возможные значения:
|
|
SEND_NOTIFICATION_EMPTY_QUEUE |
Признак уведомлений о пустой очереди. Возможные значения:
|
|
USE_WELCOME_FORM |
Признак использования приветственной формы. Возможные значения:
|
|
WELCOME_FORM_ID |
Идентификатор приветственной формы |
|
WELCOME_FORM_DELAY |
Признак задержки показа приветственной формы. Возможные значения:
|
|
SEND_WELCOME_EACH_SESSION |
Показывать приветствие в каждой сессии. Возможные значения:
|
|
CONFIRM_CLOSE |
Требовать подтверждение закрытия. Возможные значения:
|
|
IGNORE_WELCOME_FORM_RESPONSIBLE |
Игнорировать ответственного в приветственной форме. Возможные значения:
|
Объект QUEUE_FULL
|
Название |
Описание |
|
ID |
Идентификатор записи элемента очереди |
|
SORT |
Позиция в очереди |
|
USER_ID |
Идентификатор пользователя |
|
DEPARTMENT_ID |
Идентификатор подразделения |
|
USER_NAME |
Имя пользователя. Возможные значения:
|
|
USER_WORK_POSITION |
Должность пользователя. Возможные значения:
|
|
USER_AVATAR |
Ссылка на аватар. Возможные значения:
|
|
USER_AVATAR_ID |
Идентификатор файла аватара |
Объект QUEUE_USERS_FIELDS
|
Название |
Описание |
|
USER_NAME |
Имя пользователя. Возможные значения:
|
|
USER_WORK_POSITION |
Должность пользователя. Возможные значения:
|
|
USER_AVATAR |
Ссылка на аватар. Возможные значения:
|
|
USER_AVATAR_ID |
Идентификатор файла аватара |
Обработка ошибок
HTTP-статус: 400
{
"error": "CONFIG_ID_EMPTY",
"error_description": "Config ID can't be empty"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Config ID can't be empty |
Параметр |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Открытые линии в Битрикс24
- Добавить открытую линию imopenlines.config.add
- Изменить открытую линию imopenlines.config.update
- Получить список открытых линий imopenlines.config.list.get
- Удалить открытую линию imopenlines.config.delete
- Получить ссылку на публичную страницу открытых линий imopenlines.config.path.get