Update Application Data in Chat imbot.app.update

Scope: imbot

Who can execute the method: any user

The method imbot.app.update updates application data in the chat.

Warning

The required fields are the application ID and one of the necessary fields for editing. If both JS and IFRAME methods are specified in one command, only JS will be used.

Method Parameters

Required parameters are marked with *

Name

Example

Description

APP_ID*

13

Chat identifier

IFRAME

'https://marta.bitrix.com/iframe/echo.php'

URL of the frame

IFRAME_WIDTH

'350'

Desired width of the frame. Minimum value - 250px

IFRAME_HEIGHT

'150'

Desired height of the frame. Minimum value - 50px

JS_METHOD

'SEND'

JS_PARAM

'/help'

HASH

'register'

Token for accessing your frame, 32 characters

ICON_FILE

'/* base64 image */'

Icon of your application - base64

CONTEXT

'BOT'

Application context

EXTRANET_SUPPORT

'N'

Is the command available to extranet users, default N

LIVECHAT_SUPPORT

'N'

Online chat support

IFRAME_POPUP

'N'

iframe will open with the ability to move within the messenger, switching between dialogs will not close such a window

LANG

Array(...)

Array of translations, it is advisable to specify at least for DE and EN

LANGUAGE_ID (LANG)

'en'

Language identifier for translation

TITLE (LANG)

'Echobot IFRAME'

Title for the button or command in the specified language

DESCRIPTION (LANG)

'Open Echobot IFRAME app'

Command description in the specified language

COPYRIGHT (LANG)

'Bitrix24'

Copyright

Code Example

Note

This example uses the restCommand function. This is a method for sending data to Bitrix24. You can use your own function to call the method, the JavaScript method BX24.callMethod or industry standard B24PhpSDK.

How to Use Examples in Documentation

$result = restCommand(
            'imbot.app.update',
            Array(
                'APP_ID' => 13,
                'FIELDS' => Array(
                    'IFRAME' => 'https://marta.bitrix.com/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"]
        );

Successful Response

true

Possible Error Codes

Code

Description

CHAT_APP_ID_ERROR

Application not found

APP_ID_ERROR

The chat application does not belong to this rest application. You can only work with chat applications installed within the current rest application

IFRAME_HTTPS

The link to IFRAME must be on a site with an active HTTPS certificate

WRONG_REQUEST

Something went wrong

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Register a Chat Application
Next
Unregister a Chat Application