Изменить данные о приложении в чате imbot.app.update

Scope: imbot

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

Метод imbot.app.update обновляет данные о приложении в чате.

Важно

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

Параметры метода

Обязательные параметры отмечены *

Название

Пример

Описание

APP_ID*

13

Идентификатор чата

IFRAME

'https://marta.bitrix24.tech/iframe/echo.php'

URL адрес фрейма

IFRAME_WIDTH

'350'

Желаемая ширина фрейма. Минимальное значение - 250px

IFRAME_HEIGHT

'150'

Желаемая высота фрейма. Минимальное значение - 50px

JS_METHOD

'SEND'

JS_PARAM

'/help'

HASH

'register'

Токен для доступа к вашему фрейму, 32 символа

ICON_FILE

'/* base64 image */'

Иконка вашего приложения - base64

CONTEXT

'BOT'

Контекст приложения

EXTRANET_SUPPORT

'N'

Доступна ли команда пользователям экстранет, по умолчанию N

LIVECHAT_SUPPORT

'N'

Поддержка онлайн-чата

IFRAME_POPUP

'N'

iframe будет открыт с возможностью перемещения внутри мессенджера, переход между диалогами не будет закрывать такое окно

LANG

Array(...)

Массив переводов, желательно указывать как минимум для RU и EN

LANGUAGE_ID (LANG)

'en'

Идентификатор языка для перевода

TITLE (LANG)

'Echobot IFRAME'

Заголовок для кнопки или команды на указанном языке

DESCRIPTION (LANG)

'Open Echobot IFRAME app'

Описание команды на указанном языке

COPYRIGHT (LANG)

'Bitrix24'

Авторские права

Пример кода

Примечание

В примере используется функция 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

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

Код

Описание

CHAT_APP_ID_ERROR

Приложение не найдено

APP_ID_ERROR

Приложение для чата не принадлежит этому rest-приложению. Работать можно только с приложениями для чата, установленными в рамках текущего rest-приложения

IFRAME_HTTPS

Ссылка на IFRAME обязательно должна быть на сайт с активным HTTPS-сертификатом

WRONG_REQUEST

Что-то пошло не так

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

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

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Зарегистрировать приложение для чата
Следующая
Удалить приложение для чата