Документация для разработчиков
Темная тема

Провайдер чат-ботов

Провайдер чатов

Сущность "чат-бот" имеет идентификатор im-bot и реализуется классом \Bitrix\Im\Integration\UI\EntitySelector\BotProvider.

Данный провайдер реализует поиск и выбор чат-ботов, а также заполняет данными вкладку "Последние", чтобы она не была пустой.

Диалог выбора чатов

const button = document.getElementById('responsible-button');
const dialog = new Dialog({
	targetNode: button,
	enableSearch: true,
	context: 'MY_MODULE_CONTEXT',
	entities: [
		{ 
			id: 'im-bot', // чат боты
			options: { 
				searchableBotTypes: [ // типы чат-ботов, по которым следует производить поиск
					'H', // чат-бот - человек, ответы поступают с задержкой от 2-х до 10 секунд
					'B', // чат-бот, ответы от которого поступают сразу
					'S', // чат-бот с повышенными привилегиями
				] 
			}
		},
	],
});
    
button.addEventListener('click', function() {
    dialog.show();
});

Настройки провайдера


  • searchableBotTypes: array

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

    • H — чат-бот - человек, ответы поступают с задержкой от 2-х до 10 секунд.
    • B — чат-бот, ответы от которого поступают сразу.
    • S — чат-бот с повышенными привилегиями.

Ранжирование выдачи

Чем больше сообщений написали чат-боту, тем выше он в выдаче.

Дополнительная информация о чат-боте (customData)

У каждого элемента диалога в свойстве customData есть следующие ключи:

  • imBot, содержащий информацию о боте в формате, аналогичном \Bitrix\Im\Bot::getCache(<ID бота>);
  • imUser, содержащий информацию о боте как о пользователе в формате, аналогичном \Bitrix\Im\User::getList($params).

Подробнее о формате данных можно прочитать в документации.

© «Битрикс», 2001-2024, «1С-Битрикс», 2024