Skip to content

index.md

Latest commit

 

History

History
71 lines (48 loc) · 3.99 KB

index.md

File metadata and controls

71 lines (48 loc) · 3.99 KB
Raw

Bots: Overview of Methods

{% note tip "" %}

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.

{% endnote %}

The methods manage the lifecycle of a chat bot: registration, property modification, data retrieval, list viewing, and deletion.

Quick navigation: all methods

How to Work with Bots

  1. Register the bot using imbot.v2.Bot.register. The response returns botId — it is required in all other imbot.v2 calls.
  2. If necessary, update the properties using imbot.v2.Bot.update.
  3. Retrieve data for a single bot using imbot.v2.Bot.get or a list using imbot.v2.Bot.list.
  4. Delete the bot using imbot.v2.Bot.unregister if it is no longer needed.

A full description of the Bot object fields is available in Objects and Fields.

Key Bot Parameters {#key-fields}

These parameters are set during registration and determine how the bot will operate afterwards.

#| || Parameter | What It Determines | Where It Is Described in Detail || || fields.code | The unique code of the bot within the application. It allows imbot.v2.Bot.register to recognize a repeated registration and return the existing bot | imbot.v2.Bot.register || || fields.botToken | The authorization token of the bot. Required for webhook calls, not needed for OAuth. Maximum length — 40 characters | Authorization || || fields.type | The behavior of the bot in chats: bot, supervisor, personal, openline. The type determines whether the bot receives all chat messages or only mentions | Bot Types || || fields.eventMode | The event delivery method: fetch — the bot retrieves events itself, webhook — Bitrix24 sends them to the bot's URL | Event Delivery Modes || |#

Limit: a single application can register no more than 100 bots. The other limits of the section are listed in Limits.

Relationship with Other Objects {#relations}

Events. The bot receives ONIMBOTV2* events in the mode set in fields.eventMode. The event subscription is created automatically when the bot is registered and cleared when it is deleted — there is no need to call event.bind manually. Data formats are described in Events imbot.v2.

Chats. A registered bot can create group chats and manage participants. All such calls pass the botId from the imbot.v2.Bot.register response — Chats.

Commands. Slash commands are registered separately and linked to the bot by botId — Commands.

Open Channels. The fields.isSupportOpenline property enables Open Channels support for a bot of the openline type — imbot.v2.Bot.register.

Bot context. An application can pass arbitrary JSON data to the bot when a chat is opened — Passing Context to a Bot.

Overview of Methods {#all-methods}

Scope: imbot

Who can execute the methods: owner of the registered bot

#| || Method | Description || || imbot.v2.Bot.register | Registers a new bot || || imbot.v2.Bot.update | Updates the properties of the bot || || imbot.v2.Bot.get | Returns information about the bot || || imbot.v2.Bot.list | Returns a list of the application's bots || || imbot.v2.Bot.unregister | Deletes the bot || |#

Continue Your Exploration