Bitrix24 Chatbots API

The Chatbots API from Bitrix24 — 66 operation(s) for chatbots.

Operations 66

POST /im.v2 Event Formats im.v2 #
POST /im.v2.Event.get Get User Events im.v2.Event.get #
POST /im.v2.Event.subscribe Subscribe to Events im.v2.Event.subscribe #
POST /im.v2.Event.unsubscribe Unsubscribing from Events im.v2.Event.unsubscribe #
POST /im.v2.File.download Get Download Link for File im.v2.File.download #
POST /im.v2.File.upload Upload File to Chat im.v2.File.upload #
POST /imbot.bot.list Get the List of Chat Bots imbot.bot.list #
POST /imbot.chat.add Create a chat on behalf of the chat bot imbot.chat.add #
POST /imbot.chat.get Get Chat ID imbot.chat.get #
POST /imbot.chat.leave Chat Bot Exit from Specified Chat imbot.chat.leave #
POST /imbot.chat.sendTyping Send Typing Indicator imbot.chat.sendTyping #
POST /imbot.chat.setManager Assign or Revoke Chat Administrator Rights imbot.chat.setManager #
POST /imbot.chat.setOwner Change Chat Owner via imbot.chat.setOwner #
POST /imbot.chat.updateAvatar Change Chat Avatar imbot.chat.updateAvatar #
POST /imbot.chat.updateColor Change Chat Color imbot.chat.updateColor #
POST /imbot.chat.updateTitle Change Chat Title imbot.chat.updateTitle #
POST /imbot.chat.user.add Add Participants to Chat imbot.chat.user.add #
POST /imbot.chat.user.delete Exclude Participants from Chat imbot.chat.user.delete #
POST /imbot.chat.user.list Get the List of Chat Participants imbot.chat.user.list #
POST /imbot.command.answer Send a response to the command imbot.command.answer #
POST /imbot.command.register Add the imbot.command.register Command #
POST /imbot.command.unregister Remove the imbot.command.unregister Command #
POST /imbot.command.update Update the imbot.command.update #
POST /imbot.dialog.get Get Data About Chat imbot.dialog.get #
POST /imbot.message.add Send Message imbot.message.add #
POST /imbot.message.delete Delete Message imbot.message.delete #
POST /imbot.message.like Set "Like" for the message imbot.message.like #
POST /imbot.message.update Update Sent Message imbot.message.update #
POST /imbot.register Create a Chat-Bot imbot.register #
POST /imbot.unregister Unregister Chat Bot imbot.unregister #
POST /imbot.update Update Chat-Bot imbot.update #
POST /imbot.v2 Change Log for API imbot.v2 #
POST /imbot.v2.Bot.get Get Information About the Bot imbot.v2.Bot.get #
POST /imbot.v2.Bot.list List of Bots for the imbot.v2.Bot.list Application #
POST /imbot.v2.Bot.register Register a bot imbot.v2.Bot.register #
POST /imbot.v2.Bot.unregister Remove the Automation rule imbot.v2.Bot.unregister #
POST /imbot.v2.Bot.update Update the Automation rule imbot.v2.Bot.update #
POST /imbot.v2.Chat.InputAction.notify Send the bot action indicator imbot.v2.Chat.InputAction.notify #
POST /imbot.v2.Chat.Manager.add Add Chat Managers imbot.v2.Chat.Manager.add #
POST /imbot.v2.Chat.Manager.delete Remove Chat Managers imbot.v2.Chat.Manager.delete #
POST /imbot.v2.Chat.Message.Reaction.add Add Reaction to Message imbot.v2.Chat.Message.Reaction.add #
POST /imbot.v2.Chat.Message.Reaction.delete Remove Reaction from Message imbot.v2.Chat.Message.Reaction.delete #
POST /imbot.v2.Chat.Message.delete Delete Message imbot.v2.Chat.Message.delete #
POST /imbot.v2.Chat.Message.get Get Message imbot.v2.Chat.Message.get #
POST /imbot.v2.Chat.Message.getContext Get Context of Message imbot.v2.Chat.Message.getContext #
POST /imbot.v2.Chat.Message.read Mark Messages as Read imbot.v2.Chat.Message.read #
POST /imbot.v2.Chat.Message.send Send Message imbot.v2.Chat.Message.send #
POST /imbot.v2.Chat.Message.update Update Message imbot.v2.Chat.Message.update #
POST /imbot.v2.Chat.TextField.enabled Managing the Text Input Field imbot.v2.Chat.TextField.enabled #
POST /imbot.v2.Chat.User.add Add Participants to Chat imbot.v2.Chat.User.add #
POST /imbot.v2.Chat.User.delete Remove a Participant from the Chat imbot.v2.Chat.User.delete #
POST /imbot.v2.Chat.User.list List of Chat Participants imbot.v2.Chat.User.list #
POST /imbot.v2.Chat.add Create a Group Chat imbot.v2.Chat.add #
POST /imbot.v2.Chat.get Get Information About the Chat imbot.v2.Chat.get #
POST /imbot.v2.Chat.leave Leave Chat imbot.v2.Chat.leave #
POST /imbot.v2.Chat.setOwner Assign Chat Owner imbot.v2.Chat.setOwner #
POST /imbot.v2.Chat.update Update Chat Properties imbot.v2.Chat.update #
POST /imbot.v2.Command.answer Responding to the imbot.v2.Command.answer Command #
POST /imbot.v2.Command.list Get the List of Commands imbot.v2.Command.list #
POST /imbot.v2.Command.register Register the Team imbot.v2.Command.register #
POST /imbot.v2.Command.unregister Remove the imbot.v2.Command.unregister Command #
POST /imbot.v2.Command.update Update the imbot.v2.Command.update #
POST /imbot.v2.Event.get Get Events from imbot.v2.Event.get #
POST /imbot.v2.File.download Get Download Link for imbot.v2.File.download #
POST /imbot.v2.File.upload Upload File to Chat imbot.v2.File.upload #
POST /imbot.v2.Revision.get Get API Revisions imbot.v2.Revision.get #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/bitrix24-chatbots-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bitrix24-chatbots-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Bitrix24 REST BIconnector Chatbots API
  version: 1.0.0
  description: 'Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com'
  contact:
    name: Bitrix24 Developer Support
    url: https://apidocs.bitrix24.com/support.html
  license:
    name: MIT
    url: https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE
  x-logo:
    url: https://apidocs.bitrix24.com/_images/bitrix24logo.svg
servers:
- url: https://{portal}.bitrix24.com/rest
  description: Your Bitrix24 portal (cloud)
  variables:
    portal:
      default: your-portal
      description: Subdomain of your Bitrix24 portal
- url: https://{host}/rest
  description: On-Premise Bitrix24 installation
  variables:
    host:
      default: your-bitrix24.example.com
      description: Host of your on-premise installation
security:
- AccessToken: []
tags:
- name: Chatbots
paths:
  /im.v2:
    post:
      summary: Event Formats im.v2
      description: 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. Description of all events that the user application receives via [im.v2.Event.get](./event-get.md). The fields of the `message`, `chat`, and `user` objects are described in [{#T}](../../entities.md). **Quick Navigation:** [ONIMV2MESSAGEADD](#onimv2messageadd) | [ONIMV2MESSAGEUPDATE](#onimv2messageupdate) | [ONIMV2MESSAGEDELETE](#onimv2messagedelete) | [ONIMV2REACTIONCHANGE](#onimv2reactionchange) | [ONIMV2JOINCHAT](#onimv2joinchat)
      operationId: im_v2
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/events.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                Field:
                  type: string
                  description: '| Type | Description ||'
                message:
                  type: string
                  description: '| `Message` | The sent message. The description of the object''s fields — Message ||'
                chat:
                  type: string
                  description: '| `Chat` | The chat where the message was sent. The description of the object''s fields — Chat ||'
                user:
                  type: string
                  description: '| `User` | The author of the message. The description of the object''s fields — User ||'
                language:
                  type: string
                  description: '| `string` | The language of the account (e.g., `en`, `de`) ||'
                messageId:
                  type: string
                  description: '| `integer` | ID of the deleted message ||'
                reaction:
                  type: string
                  description: '| `string` | Reaction code (e.g., `like`) ||'
                action:
                  type: string
                  description: '| `string` | Action: `add` — reaction added, `delete` — removed ||'
                dialogId:
                  type: string
                  description: '| `string` | ID of the dialog (e.g., `chat5`) ||'
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                Field:
                  type: string
                  description: '| Type | Description ||'
                message:
                  type: string
                  description: '| `Message` | The sent message. The description of the object''s fields — Message ||'
                chat:
                  type: string
                  description: '| `Chat` | The chat where the message was sent. The description of the object''s fields — Chat ||'
                user:
                  type: string
                  description: '| `User` | The author of the message. The description of the object''s fields — User ||'
                language:
                  type: string
                  description: '| `string` | The language of the account (e.g., `en`, `de`) ||'
                messageId:
                  type: string
                  description: '| `integer` | ID of the deleted message ||'
                reaction:
                  type: string
                  description: '| `string` | Reaction code (e.g., `like`) ||'
                action:
                  type: string
                  description: '| `string` | Action: `add` — reaction added, `delete` — removed ||'
                dialogId:
                  type: string
                  description: '| `string` | ID of the dialog (e.g., `chat5`) ||'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
  /im.v2.Event.get:
    post:
      summary: Get User Events im.v2.Event.get
      description: '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.v2.Event.get` retrieves events for the current user in polling mode. To receive events, the user must be previously subscribed via [im.v2.Event.subscribe](./event-subscribe.md). Without a subscription, events are not recorded, and the method will return an empty array. The method uses confirmation via `offset`: pass the `nextOffset` from the previous response to get the next batch of events.'
      operationId: im_v2_Event_get
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-get.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                offset:
                  type: integer
                  description: '| Confirms processed events and returns events starting from this value. Pass the `nextOffset` from the previous response ||'
                limit:
                  type: integer
                  description: '| Maximum number of events returned (1–1000). Default is `100` ||'
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                offset:
                  type: integer
                  description: '| Confirms processed events and returns events starting from this value. Pass the `nextOffset` from the previous response ||'
                limit:
                  type: integer
                  description: '| Maximum number of events returned (1–1000). Default is `100` ||'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - im
  /im.v2.Event.subscribe:
    post:
      summary: Subscribe to Events im.v2.Event.subscribe
      description: '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.v2.Event.subscribe` subscribes the current user to event logging. After subscribing, message events are recorded in the log and become accessible through [im.v2.Event.get](./event-get.md). The method is idempotent: repeated calls are safe and do not result in an error.'
      operationId: im_v2_Event_subscribe
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-subscribe.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
          application/x-www-form-urlencoded:
            schema:
              type: object
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - im
  /im.v2.Event.unsubscribe:
    post:
      summary: Unsubscribing from Events im.v2.Event.unsubscribe
      description: '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.v2.Event.unsubscribe` cancels the current user''s subscription to event logging. It stops recording new events in the log. Already recorded events remain accessible through [im.v2.Event.get](./event-get.md) until the retention period expires (24 hours) or until confirmed via `offset`. The method is idempotent: repeated calls are safe and do not result in an error.'
      operationId: im_v2_Event_unsubscribe
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/events/event-unsubscribe.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
          application/x-www-form-urlencoded:
            schema:
              type: object
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - im
  /im.v2.File.download:
    post:
      summary: Get Download Link for File im.v2.File.download
      description: 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.v2.File.download` returns a link to download a file from the chat.
      operationId: im_v2_File_download
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-download.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                dialogId:
                  type: string
                  description: '| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||'
                fileId:
                  type: integer
                  description: '| ID of the file on Drive. Can be obtained from the response of the method im.v2.File.upload ||'
              required:
              - dialogId
              - fileId
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                dialogId:
                  type: string
                  description: '| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||'
                fileId:
                  type: integer
                  description: '| ID of the file on Drive. Can be obtained from the response of the method im.v2.File.upload ||'
              required:
              - dialogId
              - fileId
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - im
  /im.v2.File.upload:
    post:
      summary: Upload File to Chat im.v2.File.upload
      description: '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.v2.File.upload` uploads a file to the chat on behalf of the current user. It combines three steps of the deprecated API into a single call: uploading the file to the Drive, attaching it to the chat, and sending a message.'
      operationId: im_v2_File_upload
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/chat-bots-v2/im.v2/files/file-upload.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                dialogId:
                  type: string
                  description: '| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||'
                fields:
                  type: object
                  description: '| Object with file and message parameters (detailed description) ||'
                name:
                  type: string
                  description: '| File name with extension ||'
                content:
                  type: string
                  description: '| File content in Base64 encoding. Maximum size — 100 MB ||'
                message:
                  type: string
                  description: '| Text of the message sent along with the file ||'
              required:
              - dialogId
              - fields
              - name
              - content
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                dialogId:
                  type: string
                  description: '| ID of the dialog. For group chats — `chat{chatId}`, for personal chats — `{userId}` ||'
                fields:
                  type: object
                  description: '| Object with file and message parameters (detailed description) ||'
                name:
                  type: string
                  description: '| File name with extension ||'
                content:
                  type: string
                  description: '| File content in Base64 encoding. Maximum size — 100 MB ||'
                message:
                  type: string
                  description: '| Text of the message sent along with the file ||'
              required:
              - dialogId
              - fields
              - name
              - content
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - im
  /imbot.bot.list:
    post:
      summary: Get the List of Chat Bots imbot.bot.list
      description: 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. Development of this method has been halted. Please use [imbot.v2.Bot.list](../../chat-bots-v2/imbot.v2/bots/bot-list.md). The method `imbot.bot.list` returns a list of registered chat bots. No parameters required.
      operationId: imbot_bot_list
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/bots/imbot-bot-list.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                result:
                  type: object
                  description: '| An object where the top-level key is `BOT_ID`, and the value contains the bot data. The structure of the element is described in detail below ||'
                time:
                  type: string
                  description: '| Information about the request execution time ||'
                ID:
                  type: integer
                  description: '| Identifier of the chat bot ||'
                NAME:
                  type: string
                  description: '| Full name of the chat bot ||'
                CODE:
                  type: string
                  description: '| Code of the chat bot ||'
                OPENLINE:
                  type: string
                  description: '| Indicator of open line support: `Y` or `N` ||'
                Code:
                  type: string
                  description: '| Description | Value ||'
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                result:
                  type: object
                  description: '| An object where the top-level key is `BOT_ID`, and the value contains the bot data. The structure of the element is described in detail below ||'
                time:
                  type: string
                  description: '| Information about the request execution time ||'
                ID:
                  type: integer
                  description: '| Identifier of the chat bot ||'
                NAME:
                  type: string
                  description: '| Full name of the chat bot ||'
                CODE:
                  type: string
                  description: '| Code of the chat bot ||'
                OPENLINE:
                  type: string
                  description: '| Indicator of open line support: `Y` or `N` ||'
                Code:
                  type: string
                  description: '| Description | Value ||'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - imbot
  /imbot.chat.add:
    post:
      summary: Create a chat on behalf of the chat bot imbot.chat.add
      description: 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. Development of this method has been halted. Please use [imbot.v2.Chat.add](../../chat-bots-v2/imbot.v2/chats/chat-add.md). The method `imbot.chat.add` creates a chat on behalf of the chat bot.
      operationId: imbot_chat_add
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-add.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                TYPE:
                  type: string
                  description: '| Type of chat. Possible values:'
                TITLE:
                  type: string
                  description: '| Title of the chat ||'
                DESCRIPTION:
                  type: string
                  description: '| Description of the chat ||'
                COLOR:
                  type: string
                  description: '| Color of the chat for the mobile application. Possible values:'
                MESSAGE:
                  type: string
                  description: '| Welcome message in the chat ||'
                USERS:
                  type: array
                  items: {}
                  description: '| Array of chat participants ||'
                AVATAR:
                  type: string
                  description: '| Avatar of the chat in Base64 format.'
                ENTITY_TYPE:
                  type: string
                  description: '| Type of the object to bind the chat to an external context ||'
                ENTITY_ID:
                  type: string
                  description: '| Identifier of the object within `ENTITY_TYPE`.'
                BOT_ID:
                  type: integer
                  description: '| Identifier of the chat bot. You can get the bot identifier using the method imbot.bot.list.'
                CLIENT_ID:
                  type: string
                  description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||'
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                TYPE:
                  type: string
                  description: '| Type of chat. Possible values:'
                TITLE:
                  type: string
                  description: '| Title of the chat ||'
                DESCRIPTION:
                  type: string
                  description: '| Description of the chat ||'
                COLOR:
                  type: string
                  description: '| Color of the chat for the mobile application. Possible values:'
                MESSAGE:
                  type: string
                  description: '| Welcome message in the chat ||'
                USERS:
                  type: array
                  items: {}
                  description: '| Array of chat participants ||'
                AVATAR:
                  type: string
                  description: '| Avatar of the chat in Base64 format.'
                ENTITY_TYPE:
                  type: string
                  description: '| Type of the object to bind the chat to an external context ||'
                ENTITY_ID:
                  type: string
                  description: '| Identifier of the object within `ENTITY_TYPE`.'
                BOT_ID:
                  type: integer
                  description: '| Identifier of the chat bot. You can get the bot identifier using the method imbot.bot.list.'
                CLIENT_ID:
                  type: string
                  description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - imbot
  /imbot.chat.get:
    post:
      summary: Get Chat ID imbot.chat.get
      description: 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. Development of this method has been halted. Please use [imbot.v2.Chat.get](../../chat-bots-v2/imbot.v2/chats/chat-get.md). The method `imbot.chat.get` returns the chat ID. To obtain detailed information about the chat, use the method [imbot.dialog.get](./imbot-dialog-get.md).
      operationId: imbot_chat_get
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-get.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ENTITY_TYPE:
                  type: string
                  description: '| Type of the external object.'
                ENTITY_ID:
                  type: string
                  description: '| Identifier of the external object.'
              required:
              - ENTITY_TYPE
              - ENTITY_ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ENTITY_TYPE:
                  type: string
                  description: '| Type of the external object.'
                ENTITY_ID:
                  type: string
                  description: '| Identifier of the external object.'
              required:
              - ENTITY_TYPE
              - ENTITY_ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - imbot
  /imbot.chat.leave:
    post:
      summary: Chat Bot Exit from Specified Chat imbot.chat.leave
      description: 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. Development of this method has been halted. Please use [imbot.v2.Chat.leave](../../chat-bots-v2/imbot.v2/chats/chat-leave.md). The method `imbot.chat.leave` removes the chat bot from the chat.
      operationId: imbot_chat_leave
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-leave.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                CHAT_ID:
                  type: integer
                  description: '| Identifier of the chat.'
                BOT_ID:
                  type: integer
                  description: '| Identifier of the chat bot. You can get the bot''s identifier using the method imbot.bot.list.'
                CLIENT_ID:
                  type: string
                  description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||'
              required:
              - CHAT_ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CHAT_ID:
                  type: integer
                  description: '| Identifier of the chat.'
                BOT_ID:
                  type: integer
                  description: '| Identifier of the chat bot. You can get the bot''s identifier using the method imbot.bot.list.'
                CLIENT_ID:
                  type: string
                  description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the registration of the chat bot ||'
              required:
              - CHAT_ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - imbot
  /imbot.chat.sendTyping:
    post:
      summary: Send Typing Indicator imbot.chat.sendTyping
      description: 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. Development of this method has been halted. Please use [imbot.v2.Chat.InputAction.notify](../../chat-bots-v2/imbot.v2/ui/chat-input-action-notify.md). The method `imbot.chat.sendTyping` sends a typing indicator to the dialog. The method returns `true` immediately after the command is sent.
      operationId: imbot_chat_sendTyping
      tags:
      - Chatbots
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/chat-bots/outdated/chats/imbot-chat-send-typing.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                BOT_ID:
                  type: integer
                  description: '| The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method.'
                DIALOG_ID:
                  type: string
                  description: '| The identifier of the object that will receive the message: user or chat.'
                CLIENT_ID:
                  type: string
                  description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||'
              required:
              - DIALOG_ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                BOT_ID:
                  type: integer
                  description: '| The identifier of the chat bot. You can obtain the bot ID using the imbot.bot.list method.'
                DIALOG_ID:
                  type: string
                  description: '| The identifier of the object that will receive the message: user or chat.'
                CLIENT_ID:
                  type: string
                  description: '| This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot ||'
              required:
              - DIALOG_ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - imbot
  /imbot.chat.setManager:
    post:
      summary: Assign or Revoke Chat Administrator Rights imbot.chat.setManager
      description: 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. Development of this method has been halted. To assign or revoke administrator rights, use the methods [imbot.v2.Chat.Manager.add](../../chat-bots-v2/imbot.v2/chats/chat-manag

# --- truncated at 32 KB (227 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-chatbots-api-openapi.yml