{ "opencollection": "1.0.0", "info": { "name": "Bitrix24 REST BIconnector Chats API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "items": [ { "info": { "name": "Chats", "type": "folder" }, "items": [ { "info": { "name": "Create Chat im.chat.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.add` creates a new chat." }, { "info": { "name": "Get Chat ID im.chat.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.get` retrieves the chat ID." }, { "info": { "name": "Leave Chat im.chat.leave", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.leave", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.leave` removes the current user from the chat." }, { "info": { "name": "Disable Notifications from Chat im.chat.mute", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.mute", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.mute` disables or enables notifications in the specified chat." }, { "info": { "name": "Change Chat Owner im.chat.setOwner", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.setOwner", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.setOwner` changes the owner of the chat." }, { "info": { "name": "Update Chat Avatar im.chat.updateAvatar", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.updateAvatar", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.updateAvatar` updates the chat avatar." }, { "info": { "name": "Change Chat Color im.chat.updateColor", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.updateColor", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.updateColor` updates the chat color for the mobile application." }, { "info": { "name": "Update Chat Title im.chat.updateTitle", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.updateTitle", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.updateTitle` updates the chat title." }, { "info": { "name": "Invite Participants to Chat im.chat.user.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.user.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.user.add` adds users to a chat." }, { "info": { "name": "Exclude Participants from Chat im.chat.user.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.user.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.user.delete` removes a user from the chat." }, { "info": { "name": "Get Chat Participant IDs im.chat.user.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.chat.user.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.chat.user.list` returns a list of chat participant IDs." }, { "info": { "name": "Get Counters im.counters.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.counters.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.counters.get` retrieves the counters for unread messages and notifications for the current user." }, { "info": { "name": "Get the List of Colleagues for the Current User im.department.colleagues.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.department.colleagues.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.department.colleagues.list` retrieves the list of colleagues for the current user. For a manager, the method will return a list of subordinates and all supervisors." }, { "info": { "name": "Get a List of Employees from Departments im.department.employees.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.department.employees.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.department.employees.get` retrieves a list of employees from the specified departments." }, { "info": { "name": "Get Information About the Department im.department.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.department.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.department.get` retrieves data about departments by their `ID` identifiers." }, { "info": { "name": "Get a List of Department Managers im.department.managers.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.department.managers.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.department.managers.get` retrieves a list of managers for the specified departments." }, { "info": { "name": "Get Chat Data im.dialog.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.dialog.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.get` retrieves information about a chat." }, { "info": { "name": "Get the List of Recent Messages im.dialog.messages.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.dialog.messages.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.messages.get` retrieves messages from the specified dialog, including system messages. It does not support standard pagination due to the potential large volume of data. Messages can only be retrieved without participating in the chat for Open Line chats via the m" }, { "info": { "name": "Find Message in Chat im.dialog.messages.search", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.dialog.messages.search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.messages.search` performs a search for messages in the chat." }, { "info": { "name": "Set the \"read\" flag for messages im.dialog.read", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.dialog.read", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.read` sets the \"read\" flag for dialog messages up to and including the specified message." }, { "info": { "name": "Set the \"read\" flag for all chats im.dialog.read.all", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.dialog.read.all", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.read.all` sets the \"read\" flag for all chats of the current user." }, { "info": { "name": "Set the \"unread\" flag for messages im.dialog.unread", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.dialog.unread", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.unread` sets the \"unread\" flag for messages in a dialog starting from the specified message." }, { "info": { "name": "Get the List of Participants im.dialog.users.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.dialog.users.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.users.list` returns detailed information about the participants in the dialog with pagination support." }, { "info": { "name": "Send \"User is typing\" indicator im.dialog.writing", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.dialog.writing", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.dialog.writing` sends a \"User is typing\" indicator to the chat." }, { "info": { "name": "Add File to Chat im.disk.file.commit", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.disk.file.commit", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.disk.file.commit` adds a file to a chat. To add a file, specify: - one of the chat identifier parameters — `CHAT_ID` or `DIALOG_ID`" }, { "info": { "name": "Delete File from Chat Folder im.disk.file.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.disk.file.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.disk.file.delete` removes a file from the chat folder. Only the user—who is a participant in the chat and sent the file—can delete it. Other chat participants cannot delete the file. After deletion, the text *Message deleted* is displayed in the chat instead of the file." }, { "info": { "name": "Save File to Your Drive im.disk.file.save", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.disk.file.save", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.disk.file.save` saves a file from the chat to the user's personal Drive. The file is saved in the *Saved Files* folder. If the folder does not exist, the system will create it automatically." }, { "info": { "name": "Get Chat File Storage Folder im.disk.folder.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.disk.folder.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.disk.folder.get` retrieves the identifier of the folder where chat files are stored. The identifier from the response can be used in Drive methods: - [disk.folder.uploadfile](../../disk/folder/disk-folder-upload-file.md) to upload a file to the chat folder" }, { "info": { "name": "Send Message im.message.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.message.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.add` sends a message to a chat." }, { "info": { "name": "Execute the chat-bot command im.message.command", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.message.command", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.command` executes a chat-bot command in the context of a message." }, { "info": { "name": "Delete Message im.message.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.message.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.delete` removes a message." }, { "info": { "name": "Change Status to \"Like\" im.message.like", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.message.like", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.like` sets or removes the \"Like\" mark for a message." }, { "info": { "name": "Create an Object Based on the Message im.message.share", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.message.share", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.share` creates an object based on a message." }, { "info": { "name": "Update Message im.message.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.message.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.message.update` modifies the text and parameters of an already sent message." }, { "info": { "name": "Send Notification im.notify", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The `im.notify` method sends a notification to a user. The method is only available when called through the application." }, { "info": { "name": "Responding to Notifications with Quick Response im.notify.answer", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.answer", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.answer` sends a text quick response to a notification." }, { "info": { "name": "Interacting with Notification Buttons im.notify.confirm", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.confirm", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.confirm` sends the selected value of the notification button." }, { "info": { "name": "Delete Notification im.notify.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.delete` removes a notification by `ID` or by tags `TAG` and `SUB_TAG`. You must provide one of three parameters: `ID`, `TAG`, or `SUB_TAG`." }, { "info": { "name": "Get Notifications im.notify.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.get` returns a list of user notifications in parts. The next part is requested using `LAST_ID` and `LAST_TYPE`. Notification sorting: first by descending creation date, then by descending identifiers." }, { "info": { "name": "Searching Notification History im.notify.history.search", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.history.search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.history.search` performs a search through the user's notification history. Notifications are sorted first by descending creation date, then by descending identifiers." }, { "info": { "name": "Send Personal Notification im.notify.personal.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.personal.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.personal.add` sends a personal notification on behalf of the current user. The method is only available when called through an application." }, { "info": { "name": "Read or Mark Notification as Unread im.notify.read", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.read", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.read` marks a notification or all notifications as read or unread based on the specified parameters." }, { "info": { "name": "Read All Notifications im.notify.read.all", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.read.all", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.read.all` marks all notifications of the current user as read." }, { "info": { "name": "Read the list of notifications im.notify.read.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.read.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.read.list` marks a list of notifications as read or unread." }, { "info": { "name": "Get Notification Type Schema im.notify.schema.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.schema.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.schema.get` returns the schema of available notification types by modules." }, { "info": { "name": "Send System Notification im.notify.system.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.notify.system.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.notify.system.add` sends a system notification to a user. The method is only available when called through an application." }, { "info": { "name": "Pin a Chat at the Top of the im.recent List", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.recent", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.recent.pin` pins or unpins a conversation at the top of the user's chat list." }, { "info": { "name": "Get a Shortened List of Recent Chats im.recent.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.recent.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.recent.get` retrieves a list of the user's recent chats." }, { "info": { "name": "Remove Chat from the Recent List im.recent.hide", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.recent.hide", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.recent.hide` removes a dialog from the list of recent chats for the current user. You can retrieve the list of recent chats using the [im.recent.get](../im-recent-get.md) method." }, { "info": { "name": "Get the List of Chats im.recent.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.recent.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.recent.list` retrieves a list of the user's recent conversations with pagination support." }, { "info": { "name": "Set or Remove the \"Read\" Flag for the Chat im.recent.unread", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.recent.unread", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.recent.unread` sets or removes the \"read\" flag for the chat." }, { "info": { "name": "Get API Revisions im.revision.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.revision.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.revision.get` returns the API revisions of the [IM module](../../settings/cloud-and-on-premise/on-premise/versions.md) for the current Bitrix24. Use the revision values to check the compatibility of the client with the Bitrix24 server, especially on on-premise accounts wher" }, { "info": { "name": "Find Chats im.search.chat.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.search.chat.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.chat.list` performs a search for chats that the current user has access to. The search is conducted based on the title, first name, and last name of chat participants. Results are sorted in descending order of identifiers." }, { "info": { "name": "Find Departments im.search.department.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.search.department.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.department.list` performs a search for departments by their full name." }, { "info": { "name": "Add Entry to Search History im.search.last.add", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.search.last.add", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.last.add` adds a dialog to the last search history. This method was designed for the previous version of the chat. In the current M1 chat version, it works, but the results are not displayed in the interface." }, { "info": { "name": "Delete Record from Search History im.search.last.delete", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.search.last.delete", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.last.delete` removes a dialog from the last search history. This method was designed for the previous version of the chat. In the current version of the chat M1, it works, but the results are not displayed in the interface." }, { "info": { "name": "Get Search History im.search.last.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.search.last.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.last.get` returns a list of dialogs from the history of the last search. This method was designed for the previous version of the chat. In the current M1 chat version, it works, but the results are not displayed in the interface." }, { "info": { "name": "Find Users im.search.user.list", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.search.user.list", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.search.user.list` allows you to search for users by first name, last name, job title, and department." }, { "info": { "name": "Get User Data im.user.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.user.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.get` retrieves data about the current user or a user by `ID`." }, { "info": { "name": "Get User Data with im.user.list.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.user.list.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.list.get` returns data about users based on a list of identifiers. If the current user is an extranet user, the method will return data only for users from their extranet groups. User identifiers outside these groups will be skipped without error." }, { "info": { "name": "Get User Status im.user.status.get", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.user.status.get", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.status.get` returns the status of the current user. The method returns the status that was set using the [im.user.status.set](./im-user-status-set.md) method." }, { "info": { "name": "Disable Automatic Status \"Away\" im.user.status.idle.end", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.user.status.idle.end", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.status.idle.end` disables the automatic \"Away\" status for the current user. This method was designed for the previous version of the chat. In the current version of the chat M1, it works, but the results are not displayed in the interface. - [Bitrix24 Chat: New Mess" }, { "info": { "name": "Enable Automatic Status \"Away\" im.user.status.idle.start", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.user.status.idle.start", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.status.idle.start` enables the automatic status \"Away\" for the current user. This method was designed for the previous version of the chat. In the current M1 chat version, it works, but the results are not displayed in the interface. - [Bitrix24 Chat: New Messenger]" }, { "info": { "name": "Set User Status im.user.status.set", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/im.user.status.set", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `im.user.status.set` sets the current user's status. To check the current status, use the method [im.user.status.get](./im-user-status-get.md)." }, { "info": { "name": "Register a Chat Application imbot.app.register", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/imbot.app.register", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.app.register` registers a chat application. Applications are divided into two types: [JS command and IFRAME application](../chat-apps.md)." }, { "info": { "name": "Unregister Chat Application imbot.app.unregister", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/imbot.app.unregister", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.app.unregister` removes the application from the chat." }, { "info": { "name": "Update Application Data in Chat imbot.app.update", "type": "http" }, "http": { "method": "POST", "url": "https://{portal}.bitrix24.com/rest/imbot.app.update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "auth", "value": "{{auth}}", "placement": "query" } }, "docs": "If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `imbot.app.update` updates application data in the chat. 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." } ] } ], "bundled": true }