How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitrix24 Chatbots API

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

Bitrix24 Chatbots API is one of 36 APIs that Bitrix24 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chatbots. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 66 operations across 66 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://{portal}.bitrix24.com/rest, https://{host}/rest.

66 operations 66 paths 3 schemas 66 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://{installation}.bitrix24.com/rest/
Authentication
API Key, OAuth 2.0
License
Resource Areas
1

Authentication & Security 2

Bitrix24 Chatbots API declares 2 security schemes for authenticating requests. An API key is passed in the query as auth (AccessToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 45 scopes. By default, every request must be authenticated.

  • AccessToken — OAuth 2.0 accesstoken or incoming webhook token
  • OAuth2 — OAuth 2.0 authorization

Paths & Operations 66

Across 66 paths, the API surfaces 66 operations — 66 POST. Each is listed below with its method, path, parameters, and response codes.

Chatbots 66
POST
/im.v2
Event Formats im.v2
im_v2 body → 2004XX
POST
/im.v2.Event.get
Get User Events im.v2.Event.get
im_v2_Event_get body → 2004XX
POST
/im.v2.Event.subscribe
Subscribe to Events im.v2.Event.subscribe
im_v2_Event_subscribe body → 2004XX
POST
/im.v2.Event.unsubscribe
Unsubscribing from Events im.v2.Event.unsubscribe
im_v2_Event_unsubscribe body → 2004XX
POST
/im.v2.File.download
Get Download Link for File im.v2.File.download
im_v2_File_download body → 2004XX
POST
/im.v2.File.upload
Upload File to Chat im.v2.File.upload
im_v2_File_upload body → 2004XX
POST
/imbot.bot.list
Get the List of Chat Bots imbot.bot.list
imbot_bot_list body → 2004XX
POST
/imbot.chat.add
Create a chat on behalf of the chat bot imbot.chat.add
imbot_chat_add body → 2004XX
POST
/imbot.chat.get
Get Chat ID imbot.chat.get
imbot_chat_get body → 2004XX
POST
/imbot.chat.leave
Chat Bot Exit from Specified Chat imbot.chat.leave
imbot_chat_leave body → 2004XX
POST
/imbot.chat.sendTyping
Send Typing Indicator imbot.chat.sendTyping
imbot_chat_sendTyping body → 2004XX
POST
/imbot.chat.setManager
Assign or Revoke Chat Administrator Rights imbot.chat.setManager
imbot_chat_setManager body → 2004XX
POST
/imbot.chat.setOwner
Change Chat Owner via imbot.chat.setOwner
imbot_chat_setOwner body → 2004XX
POST
/imbot.chat.updateAvatar
Change Chat Avatar imbot.chat.updateAvatar
imbot_chat_updateAvatar body → 2004XX
POST
/imbot.chat.updateColor
Change Chat Color imbot.chat.updateColor
imbot_chat_updateColor body → 2004XX
POST
/imbot.chat.updateTitle
Change Chat Title imbot.chat.updateTitle
imbot_chat_updateTitle body → 2004XX
POST
/imbot.chat.user.add
Add Participants to Chat imbot.chat.user.add
imbot_chat_user_add body → 2004XX
POST
/imbot.chat.user.delete
Exclude Participants from Chat imbot.chat.user.delete
imbot_chat_user_delete body → 2004XX
POST
/imbot.chat.user.list
Get the List of Chat Participants imbot.chat.user.list
imbot_chat_user_list body → 2004XX
POST
/imbot.command.answer
Send a response to the command imbot.command.answer
imbot_command_answer body → 2004XX
POST
/imbot.command.register
Add the imbot.command.register Command
imbot_command_register body → 2004XX
POST
/imbot.command.unregister
Remove the imbot.command.unregister Command
imbot_command_unregister body → 2004XX
POST
/imbot.command.update
Update the imbot.command.update
imbot_command_update body → 2004XX
POST
/imbot.dialog.get
Get Data About Chat imbot.dialog.get
imbot_dialog_get body → 2004XX
POST
/imbot.message.add
Send Message imbot.message.add
imbot_message_add body → 2004XX
POST
/imbot.message.delete
Delete Message imbot.message.delete
imbot_message_delete body → 2004XX
POST
/imbot.message.like
Set "Like" for the message imbot.message.like
imbot_message_like body → 2004XX
POST
/imbot.message.update
Update Sent Message imbot.message.update
imbot_message_update body → 2004XX
POST
/imbot.register
Create a Chat-Bot imbot.register
imbot_register body → 2004XX
POST
/imbot.unregister
Unregister Chat Bot imbot.unregister
imbot_unregister body → 2004XX
POST
/imbot.update
Update Chat-Bot imbot.update
imbot_update body → 2004XX
POST
/imbot.v2
Change Log for API imbot.v2
imbot_v2 body → 2004XX
POST
/imbot.v2.Bot.get
Get Information About the Bot imbot.v2.Bot.get
imbot_v2_Bot_get body → 2004XX
POST
/imbot.v2.Bot.list
List of Bots for the imbot.v2.Bot.list Application
imbot_v2_Bot_list body → 2004XX
POST
/imbot.v2.Bot.register
Register a bot imbot.v2.Bot.register
imbot_v2_Bot_register body → 2004XX
POST
/imbot.v2.Bot.unregister
Remove the Automation rule imbot.v2.Bot.unregister
imbot_v2_Bot_unregister body → 2004XX
POST
/imbot.v2.Bot.update
Update the Automation rule imbot.v2.Bot.update
imbot_v2_Bot_update body → 2004XX
POST
/imbot.v2.Chat.InputAction.notify
Send the bot action indicator imbot.v2.Chat.InputAction.notify
imbot_v2_Chat_InputAction_notify body → 2004XX
POST
/imbot.v2.Chat.Manager.add
Add Chat Managers imbot.v2.Chat.Manager.add
imbot_v2_Chat_Manager_add body → 2004XX
POST
/imbot.v2.Chat.Manager.delete
Remove Chat Managers imbot.v2.Chat.Manager.delete
imbot_v2_Chat_Manager_delete body → 2004XX
POST
/imbot.v2.Chat.Message.Reaction.add
Add Reaction to Message imbot.v2.Chat.Message.Reaction.add
imbot_v2_Chat_Message_Reaction_add body → 2004XX
POST
/imbot.v2.Chat.Message.Reaction.delete
Remove Reaction from Message imbot.v2.Chat.Message.Reaction.delete
imbot_v2_Chat_Message_Reaction_delete body → 2004XX
POST
/imbot.v2.Chat.Message.delete
Delete Message imbot.v2.Chat.Message.delete
imbot_v2_Chat_Message_delete body → 2004XX
POST
/imbot.v2.Chat.Message.get
Get Message imbot.v2.Chat.Message.get
imbot_v2_Chat_Message_get body → 2004XX
POST
/imbot.v2.Chat.Message.getContext
Get Context of Message imbot.v2.Chat.Message.getContext
imbot_v2_Chat_Message_getContext body → 2004XX
POST
/imbot.v2.Chat.Message.read
Mark Messages as Read imbot.v2.Chat.Message.read
imbot_v2_Chat_Message_read body → 2004XX
POST
/imbot.v2.Chat.Message.send
Send Message imbot.v2.Chat.Message.send
imbot_v2_Chat_Message_send body → 2004XX
POST
/imbot.v2.Chat.Message.update
Update Message imbot.v2.Chat.Message.update
imbot_v2_Chat_Message_update body → 2004XX
POST
/imbot.v2.Chat.TextField.enabled
Managing the Text Input Field imbot.v2.Chat.TextField.enabled
imbot_v2_Chat_TextField_enabled body → 2004XX
POST
/imbot.v2.Chat.User.add
Add Participants to Chat imbot.v2.Chat.User.add
imbot_v2_Chat_User_add body → 2004XX
POST
/imbot.v2.Chat.User.delete
Remove a Participant from the Chat imbot.v2.Chat.User.delete
imbot_v2_Chat_User_delete body → 2004XX
POST
/imbot.v2.Chat.User.list
List of Chat Participants imbot.v2.Chat.User.list
imbot_v2_Chat_User_list body → 2004XX
POST
/imbot.v2.Chat.add
Create a Group Chat imbot.v2.Chat.add
imbot_v2_Chat_add body → 2004XX
POST
/imbot.v2.Chat.get
Get Information About the Chat imbot.v2.Chat.get
imbot_v2_Chat_get body → 2004XX
POST
/imbot.v2.Chat.leave
Leave Chat imbot.v2.Chat.leave
imbot_v2_Chat_leave body → 2004XX
POST
/imbot.v2.Chat.setOwner
Assign Chat Owner imbot.v2.Chat.setOwner
imbot_v2_Chat_setOwner body → 2004XX
POST
/imbot.v2.Chat.update
Update Chat Properties imbot.v2.Chat.update
imbot_v2_Chat_update body → 2004XX
POST
/imbot.v2.Command.answer
Responding to the imbot.v2.Command.answer Command
imbot_v2_Command_answer body → 2004XX
POST
/imbot.v2.Command.list
Get the List of Commands imbot.v2.Command.list
imbot_v2_Command_list body → 2004XX
POST
/imbot.v2.Command.register
Register the Team imbot.v2.Command.register
imbot_v2_Command_register body → 2004XX
POST
/imbot.v2.Command.unregister
Remove the imbot.v2.Command.unregister Command
imbot_v2_Command_unregister body → 2004XX
POST
/imbot.v2.Command.update
Update the imbot.v2.Command.update
imbot_v2_Command_update body → 2004XX
POST
/imbot.v2.Event.get
Get Events from imbot.v2.Event.get
imbot_v2_Event_get body → 2004XX
POST
/imbot.v2.File.download
Get Download Link for imbot.v2.File.download
imbot_v2_File_download body → 2004XX
POST
/imbot.v2.File.upload
Upload File to Chat imbot.v2.File.upload
imbot_v2_File_upload body → 2004XX
POST
/imbot.v2.Revision.get
Get API Revisions imbot.v2.Revision.get
imbot_v2_Revision_get body → 2004XX

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BitrixTime (8 properties), BitrixResponse (4 properties), BitrixError (2 properties). Each schema is shown below with its type and property counts.

BitrixError
object
Bitrix24 REST API error response
2 properties 2 required
BitrixTime
object
Request execution time information
8 properties
BitrixResponse
object
Standard Bitrix24 REST API response
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitrix24-chatbots-api-openapi.yml Raw ↑

Other APIs Bitrix24 publishes across the network.

Bitrix24 REST API
Bitrix24 BIconnector API
Bitrix24 Business Processes API
Bitrix24 Calendar API
Bitrix24 Chats API
Bitrix24 Company Structure API
Bitrix24 CoPilot / AI API
Bitrix24 CRM API
Bitrix24 Data Storage API
Bitrix24 Deprecated Methods API
Bitrix24 Document Generator API
Bitrix24 Drive API
Where this information came from

This is an independent, third-party profile of Bitrix24 Chatbots API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.