Блог Горошко Андрея Bitrix24 Добавить команду imbot.command.register

Добавить команду imbot.command.register

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Добавить команду imbot.command.register», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Добавить команду imbot.command.register

Тут может не хватать некоторых данных — дополним в ближайшее время

  • нужны правки под стандарт написания
  • не указаны типы параметров
  • не указана обязательность параметров
  • не для всех параметров есть пример в таблице
  • отсутствуют примеры
  • отсутствует ответ в случае успеха
  • отсутствует ответ в случае ошибки
  • не прописаны ссылки на несозданные ещё страницы

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

Метод imbot.command.register регистрирует команду для обработки чат-ботом.

ПараметрПримерОписаниеРевизия
BOT_ID
unknown
62Идентификатор чат-бота владельца команды
COMMAND
unknown
'echo'Текст команды, которую пользователь будет вводить в чатах.

Можно использовать только латинские буквы и цифры. Не принимает пробелы и спецсимволы

COMMON
unknown
'Y'Если указан Y, то команда доступна во всех чатах, если N — то доступна только в тех, где присутствует чат-бот
HIDDEN
unknown
'N'Скрытая команда или нет — по умолчанию N
EXTRANET_SUPPORT
unknown
'N'Доступна ли команда пользователям Экстранет, по умолчанию N
CLIENT_ID
unknown
''Строковый идентификатор чат-бота, используется только в режиме Вебхуков
*LANG^^
unknown
Array(
    Array(
        'LANGUAGE_ID' => 'en',
        'TITLE' => 'Get echo message',
        'PARAMS' => 'some text'
    )
)
Массив переводов, обязательно указывать как минимум для RU и EN
EVENT_COMMAND_ADD
unknown
'http://www.hazz/chatApi/bot.php'Ссылка на обработчик для команд

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

Предупреждение
Внимание! Если планируется устанавливать более одной команды для чат-бота: Bitrix24 Rest накладывает ограничение на работу с обработчиками событий — обработчик может быть только один на одно приложение. Поэтому при регистрации второй команды ссылки на обработчики EVENT_COMMAND_ADD должны быть такими же, как и у первой команды.

Если необходимо обрабатывать несколько команд в рамках одного приложения, то необходимо предусмотреть это внутри обработчика событий. Для этого при поступлении события передается массив команд, чтобы можно было корректно их обработать.

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

Практические примеры использования в коде

  • PHP
    $result = restCommand(
        'imbot.command.register',
        Array(
            'BOT_ID' => 62,
            'COMMAND' => 'echo',
            'COMMON' => 'Y',
            'HIDDEN' => 'N',
            'EXTRANET_SUPPORT' => 'N',
            'CLIENT_ID' => '',
            'LANG' => Array(
                Array(
                    'LANGUAGE_ID' => 'en',
                    'TITLE' => 'Get echo message',
                    'PARAMS' => 'some text'
                ),
            ),
            'EVENT_COMMAND_ADD' => 'http://www.hazz/chatApi/bot.php',
        ),
        $_REQUEST[
            "auth"
        ]
    );

Ответ в случае успеха

Идентификатор команды COMMAND_ID.

Ответ в случае ошибки

ошибка

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

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

Ссылки по теме

  • Событие на получение чат-ботом команды ONIMCOMMANDADD

💡 Экспертное мнение и рекомендации

Ключевые выводы по теме «Добавить команду imbot.command.register»:

Использование современных стандартов D7 при работе с imbot.command.register позволяет писать чистый, масштабируемый и безопасный код. Не забывайте обрабатывать исключения (try/catch) и проверять права доступа текущего пользователя перед выполнением критических операций.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Подключение и настройка IP-телефонии в Битрикс24 (Mango, UIS, Zadarma)Подключение и настройка IP-телефонии в Битрикс24 (Mango, UIS, Zadarma)

Профессиональная настройка и внедрение Битрикс24 CRM позволяет систематизировать работу отдела продаж, исключить потерю лидов и автоматизировать ключевые бизнес-процессы компании. Услуга «Подключение и настройка IP-телефонии в Битрикс24 (Mango, UIS, Zadarma)» обеспечивает

Отправить пакет запросов BX24.callBatchОтправить пакет запросов BX24.callBatch

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Отправить пакет запросов BX24.callBatch». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции. Отправить

Как использовать метод SDK sale.property.get в Битрикс24Как использовать метод SDK sale.property.get в Битрикс24

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Как использовать метод SDK sale.property.get в Битрикс24», проанализируем