imbot.command.update

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

Анна Кокина

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

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

Обновление данных в команде

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

Обратите внимание! Для обработки команды нужно, чтобы в приложении была обработка события добавления команды ONIMCOMMANDADD.

Вызов метода

$result = restCommand('imbot.command.update', Array(

   'COMMAND_ID' => 13, // Идентификатор чата
   'FIELDS' => Array(
      'EVENT_COMMAND_ADD' => 'http://www.hazz/chatApi/bot.php', // Ссылка на обработчик команд
      'HIDDEN' => 'N', // Скрытая команда или нет
      'EXTRANET_SUPPORT' => 'N', // Доступна ли команда пользователям Экстранет
      'CLIENT_ID' => '', // Строковый идентификатор чат-бота, используется только в режиме Вебхуков
      'LANG' => Array( // Новые фразы перевода, все предыдущие будут удалены
         Array('LANGUAGE_ID' => 'en', 'TITLE' => 'Get echo message', 'PARAMS' => 'some text'),
      ),
   )

), $_REQUEST["auth"]);

Обязательные поля: идентификатор команды и одно из нужных полей для редактирования.

Важно! Обязательно указывать массив переводов LANG как минимум для RU и EN. Если нет фразы для BY, UA, KZ, то показываются по умолчанию фразы RU, если в RU нет фразы - команда скрывается. Для остальных языков тоже самое - если нет фраз, то по умолчанию показываются фразы EN, если в EN нет фразы, то команда скрывается в публичной части.

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

true или ошибка.

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

Код	Описание
COMMAND_ID_ERROR	Команда не найдена.
APP_ID_ERROR	Чат-бот не принадлежит этому приложению. Работать можно только с чат-ботами, установленными в рамках приложения.
EVENT_COMMAND_ADD	Ссылка обработчик события невалидная или не указана.
WRONG_REQUEST	Что-то пошло не так.

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