Interface, Navigation, and Context: Overview of Methods
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Additional methods manage the interface of the embedded application in Bitrix24. They allow you to resize frames, open sliders and windows, handle page events, and invoke messenger methods.
Quick navigation: all methods
How to Choose the Right Method
- If you need to manage the application window or frame, start with BX24.resizeWindow, BX24.fitWindow, BX24.setTitle, BX24.openApplication, and BX24.closeApplication.
- If you need to open a section of Bitrix24, a chat, or a call from the application interface, use BX24.openPath, Messenger.openChat, Messenger.startVideoCall, or Messenger.startPhoneCall.
- If you need to wait for the DOM structure of the page to be ready or bind an event handler, use BX24.ready, BX24.isReady, BX24.bind, BX24.unbind, BX24.proxy, and BX24.proxyContext.
- If you need to retrieve runtime environment data, check BX24.isAdmin, BX24.getLang, BX24.getDomain, and BX24.getScrollSize.
Interaction with Other Objects
System Interface of Bitrix24. The method BX24.openPath utilizes the built-in Bitrix24 slider to open pages and objects. The methods Messenger.openChat, Messenger.startVideoCall, and Messenger.startPhoneCall launch the system interface elements of Bitrix24's messenger and telephony.
Embedding Locations. For scenarios involving embeddings, register a handler via placement.bind and select an appropriate embedding location from the list of embedding locations. This is particularly important for the methods BX24.reloadWindow and BX24.scrollParentWindow, which depend on the context of the application's placement.
Overview of Methods
Window and Frame Management
|
Method |
Description |
|
Resizes the frame containing the application |
|
|
Adjusts the frame size to fit the content |
|
|
Reloads the page with the application (the entire page, not just the frame) |
|
|
Sets the page title |
|
|
Opens the application |
|
|
Closes the currently open modal window with the application |
|
|
Scrolls the parent window |
Page Events and Call Context
|
Method |
Description |
|
Sets an event handler for "DOM structure of the document is ready for use" |
|
|
Indicates whether the DOM structure of the document is ready for use |
|
|
Returns a proxy function and reuses it when called with the same parameters |
|
|
When called from within a proxy function, it will return a reference to the original execution context of the proxy function |
|
|
Sets the function func as the event handler for eventName of the element object |
|
|
Removes the function func as the event handler for eventName of the element object |
Environment Data and Resource Loading
|
Method |
Description |
|
Determines whether the current user has permissions to manage applications |
|
|
Returns the language identifier in the current Bitrix24 |
|
|
Returns the value of |
|
|
Returns the internal dimensions of the application frame |
|
|
Loads and executes a client-side JavaScript file |
Navigation and Communication
|
Method |
Description |
|
Opens a path within Bitrix24 in the slider |
|
|
Initiates a video call from the Bitrix24 interface |
|
|
Initiates a phone call from the Bitrix24 interface |
|
|
Opens a chat, message history, or chat list |