Bitrix24 Bot Platform

Added support for ACTION and ACTION_VALUE (REST revision 28):

• in keyboards
• in context menu

New methods in Chat API:

• Gets information about dialog/chat – im.dialog.get

New methods in Bot API:

• Get information about dialog/chat – imbot.dialog.get

• Added new parameter LAST_UPDATE to the method User recent dialogs list (im.recent.get) from revision 23 – limit for retrieved data with date in ATOM format.

• The methods Updated message read status (im.dialog.read) has an updated response format starting from revision 23.

• Block with hyperlinks
• Block with images

Fields WIDTH and HEIGHT are optional, but recommended for correct image display.

• Saving file in your Bitrix24.Drive - im.disk.file.save
• Modifying the 'message read' status: all messages prior to the specified message (including the message itself) are marked as read - im.dialog.read
• Modifying 'message read' status: all messages after the specified message (including the message itself) are marked as unread - im.dialog.unread

New methods in Chat API:

• im.revision.get - Platform version;
• im.chat.mute - Disables notifications in chat;
• im.dialog.messages.get - Gets the list of last messages in chat;
• im.disk.folder.get - Gets information on folder storing files for chat;
• im.disk.file.commit - Publishes loaded file in the chat;
• im.disk.file.delete - Deletes files inside chat folder;
• im.user.get - Gets user data;
• im.user.list.get - Gets multiple users data;
• im.user.business.list - Gets list of users with access to business tools;
• im.user.status.get - Gets information on the specified user status;
• im.user.status.set - Specifies user status;
• im.user.status.idle.start - Specifies automatic status "Away";
• im.user.status.idle.end - Disables automatic status "Away";
• im.department.get - Gets department data;
• im.department.colleagues.list - Gets list of users in your department;
• im.department.managers.get - Gets list of department managers;
• im.department.employees.get - Gets list of employees in a department;
• im.search.user.list - Searches for users;
• im.search.chat.list - Searches for chats;
• im.search.department.list - Searches for departments;
• im.search.last.get - Gets list of elements of the last search;
• im.search.last.add - Adds a history element of the last search;
• im.search.last.delete - Deletes a history element of the last search;
• im.recent.get - Gets the last user dialogs;
• im.recent.pin - Pins dialog in favorites;
• im.recent.hide - Deletes dialog from the list of recent chats;
• im.counters.get - Gets counter data;
• im.notify.read - Cancels notification for read messages;

• The following fields: EVENT_MESSAGE_UPDATE and EVENT_MESSAGE_DELETE were added to the methods imbot.register and imbot.update to enable subscription to events that update and delete messages.

• New chatbot type with with advanced privileges (supervisor) was added. It is the chatbot that has access to all messages in chats, where it is a participant (to all chats, if it was invited with the access to history, and to new chats, if the access to history is not available to it).

  To create a chatbot with advanced privileges, specify type S in the TYPE field in the imbot.register method.

  Please be advised, if not required by the logic of your app, it is recommended for the chatbot to respond to the user messages only if this chatbot is mentioned. It can be checked via the TO_USER_ID field, which will be passed into the event.

  Another addition were the handlers that trace message edits and deletions (available for the chatbot of this type).

• The following new fields ENTITY_TYPE and ENTITY_ID were added to the method im.chat.add. These fields are used to perform quick search and identification of a chat in the following events: EVENT_MESSAGE_ADD, EVENT_MESSAGE_UPDATE, EVENT_MESSAGE_DELETE.

• Method imbot.update no longer supports updates of the TYPE and OPENLINE fields.

• New method is added: im.chat.get. It uses ENTITY_TYPE and ENTITY_ID to receive chat ID.

• The following fields CHAT_ENTITY_TYPE and CHAT_ENTITY_ID were added to these events: EVENT_MESSAGE_ADD, EVENT_MESSAGE_UPDATE, EVENT_MESSAGE_DELETE to identify a chat (you can specify these fields at the moment of creation).

• The field TO_USER_ID is added to the following events: EVENT_MESSAGE_ADD, EVENT_MESSAGE_UPDATE. This field will contain the ID of the mentioned user. Thanks to this addition, in case of the 'S' type bot you will be able to understand, whether to respond or not to respond.

• Update for imbot.register and imbot.update: if all your event handlers will input the same address, instead of specifying EVENT_MESSAGE_ADD, EVENT_MESSAGE_UPDATE, EVENT_MESSAGE_DELETE, EVENT_WELCOME_MESSAGE, EVENT_BOT_DELETE - you can specify only EVENT_HANDLER - its value will be automatically written into all the event handlers.

• Method im.chat.add was supplemented by a new OWNER_ID field, via which you can specify the chat owner.

• The following methods were added to the Working with Chats (Bot API) section:

  • imbot.chat.add - create chat on behalf of chatbot;
  • imbot.chat.get - get chat ID;
  • imbot.chat.setOwner - change chat owner on behalf of chatbot.

• Parameter BOT_ID was added to all the Working with Chats (Bot API) methods.

• New error code MAX_COUNT_ERROR was added to the method imbot.register - it notifies that the maximum number of registered bots was reached for one application.
• Now, maximum quantity of bots for single application is 5.