Изменить данные о приложении в чате imbot.app.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imbotКто может выполнять метод: любой пользователь
Метод imbot.app.update обновляет данные о приложении в чате.
Важно
Обязательными полями является идентификатор приложения и одно из нужных полей для редактирования. Если указать методы JS и IFRAME в одной команде, будут использованы только JS.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Пример |
Описание |
|
APP_ID* |
|
Идентификатор чата |
|
IFRAME |
|
URL адрес фрейма |
|
IFRAME_WIDTH |
|
Желаемая ширина фрейма. Минимальное значение - 250px |
|
IFRAME_HEIGHT |
|
Желаемая высота фрейма. Минимальное значение - 50px |
|
JS_METHOD |
|
|
|
JS_PARAM |
|
|
|
HASH |
|
Токен для доступа к вашему фрейму, 32 символа |
|
ICON_FILE |
|
Иконка вашего приложения - base64 |
|
CONTEXT |
|
Контекст приложения |
|
EXTRANET_SUPPORT |
|
Доступна ли команда пользователям экстранет, по умолчанию N |
|
LIVECHAT_SUPPORT |
|
Поддержка онлайн-чата |
|
IFRAME_POPUP |
|
iframe будет открыт с возможностью перемещения внутри мессенджера, переход между диалогами не будет закрывать такое окно |
|
LANG |
|
Массив переводов, желательно указывать как минимум для RU и EN |
|
LANGUAGE_ID (LANG) |
|
Идентификатор языка для перевода |
|
TITLE (LANG) |
|
Заголовок для кнопки или команды на указанном языке |
|
DESCRIPTION (LANG) |
|
Описание команды на указанном языке |
|
COPYRIGHT (LANG) |
|
Авторские права |
Пример кода
Примечание
В примере используется функция restCommand. Это метод отправки данных в Битрикс24. Другой пример использования метода вы найдете в примере ЭхоБота. Вы можете использовать для вызова метода свою функцию, javascript-метод BX24.callMethod или bitrix24-php-sdk.
Как использовать примеры в документации
$result = restCommand(
'imbot.app.update',
Array(
'APP_ID' => 13,
'FIELDS' => Array(
'IFRAME' => 'https://marta.bitrix24.tech/iframe/echo.php',
'IFRAME_WIDTH' => '350',
'IFRAME_HEIGHT' => '150',
'JS_METHOD' => 'SEND',
'JS_PARAM' => '/help',
'HASH' => 'register',
'ICON_FILE' => '/* base64 image */',
'CONTEXT' => 'BOT',
'EXTRANET_SUPPORT' => 'N',
'LIVECHAT_SUPPORT' => 'N',
'IFRAME_POPUP' => 'N',
'LANG' => Array(
Array(
'LANGUAGE_ID' => 'en',
'TITLE' => 'Echobot IFRAME',
'DESCRIPTION' => 'Open Echobot IFRAME app',
'COPYRIGHT' => 'Bitrix24'
),
)
)
),
$_REQUEST["auth"]
);
Ответ в случае успеха
true
Возможные коды ошибок
|
Код |
Описание |
|
|
Приложение не найдено |
|
|
Приложение для чата не принадлежит этому rest-приложению. Работать можно только с приложениями для чата, установленными в рамках текущего rest-приложения |
|
|
Ссылка на |
|
|
Что-то пошло не так |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |