imbot.chat.add

Просмотров: 13278
Дата последнего изменения: 12.07.2023

Анна Кокина

Сложность урока:

3 уровень - средняя сложность. Необходимо внимание и немного подумать.

Создание чата от лица чат-бота

Обратите внимание! Метод указан с использованием функции restCommand - это метод отправки данных в Битрикс24, данный метод есть в примере ЭхоБота и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод BX24.callMethod или bitrix24-php-sdk.

Вызов метода

$result = restCommand('imbot.chat.add', Array(

   'TYPE' => 'CHAT' // OPEN - открытый для вступления чат, CHAT – обычный чат по приглашениям, по умолчанию CHAT
   'TITLE' => 'Мой новый закрытый чат', // Заголовок 
   'DESCRIPTION' => 'Очень важные события', // Описание 
   'COLOR' => 'PINK', // Цвет для мобильного приложения - RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN,  AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE
   'MESSAGE' => 'Добро пожаловать!', // Первое приветственное сообщение в чате
   'USERS' => Array(1,2), // Участники (обяз.)
   'AVATAR' => '/* base64 image */', // Аватар в base64 формате
   'ENTITY_TYPE' => 'CHAT', // Идентификатор произвольной сущности (например CHAT, CRM, OPENLINES, CALL и тд), может быть использован для поиска чата и для легкого определения контекста в обработчиках событий ONIMBOTMESSAGEADD, ONIMBOTMESSAGEUPDATE, ONIMBOTMESSAGEDELETE
   'ENTITY_ID' => 13, // Числовой идентификатор сущности, может быть использован для поиска чата и для легкого определения контекста в обработчиках событий ONIMBOTMESSAGEADD, ONIMBOTMESSAGEUPDATE, ONIMBOTMESSAGEDELETE
   'OWNER_ID' => 39, // Идентификатор владельца. Можно не указывать, если вы создаете чат под нужным пользователем
   'BOT_ID' => 39, // Идентификатор бота, от которого идет запрос. Можно не указывать, если он всего один

), $_REQUEST["auth"]);

Обязательные поля: USERS (участники чата).

Результат выполнения

Числовой идентификатор CHAT_ID или ошибка.

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

Код	Описание
USERS_EMPTY	Не переданы участники чата.
WRONG_REQUEST	Что-то пошло не так.

Курсы разработаны в компании «1С-Битрикс»