About Chats in Bitrix24

We are still updating this page

Some data may be missing — we will complete it shortly.

Method	Description
im.chat.add	Creates a chat
im.chat.get	Retrieves the chat ID
im.counters.get	Retrieves counters
im.dialog.get	Retrieves chat data
im.recent.get	Retrieves a shortened list of recent chats
im.recent.list	Retrieves a list of chats

Changing a Chat

Method	Description
im.chat.setOwner	Changes the chat owner
im.chat.updateAvatar	Changes the chat avatar
im.chat.updateColor	Changes the chat color
im.chat.updateTitle	Changes the chat title

Chat Participants

Method	Description
im.chat.leave	Leaves the chat
im.chat.user.add	Invites participants to the chat
im.chat.user.delete	Removes participants from the chat
im.chat.user.list	Retrieves chat participant IDs
im.dialog.users.list	Retrieves the list of participants

Working with Departments

Method	Description
im.department.colleagues.list	Retrieves the list of users in your department
im.department.employees.get	Retrieves the list of department employees
im.department.get	Retrieves information about the department
im.department.managers.get	Retrieves the list of department managers

Working with Files in Chats

Method	Description
im.disk.file.commit	Adds a file to the chat
im.disk.file.delete	Deletes a file from the chat folder
im.disk.file.save	Saves a file to your disk
im.disk.folder.get	Retrieves the file storage folder of the specified chat

Messages

Method	Description
im.dialog.messages.get	Retrieves the list of recent messages
im.dialog.read	Marks messages as "read"
im.dialog.unread	Marks messages as "unread"
im.dialog.writing	Sends the "someone is typing..." status
im.message.add	Adds a message
im.message.command	Uses a bot command
im.message.delete	Deletes a bot message
im.message.like	Changes the "Like" status of a message
im.message.share	Creates an object based on a message
im.message.update	Modifies a sent message

Notifications

Method	Description
im.notify.answer	Responds to a notification that supports quick replies
im.notify.confirm	Interacts with notification buttons
im.notify.delete	Deletes notifications
im.notify.personal.add	Sends a personal notification
im.notify.read.list	Reads the list of notifications (except CONFIRM)
im.notify.read	Cancels read notifications
im.notify.system.add	Sends a system notification

Search

Method	Description
im.search.chat.list	Finds chats by names
im.search.department.list	Finds departments
im.search.last.add	Adds search to history
im.search.last.delete	Deletes search from history
im.search.last.get	Retrieves search history
im.search.user.list	Finds users

Special Operations in Chats

Method	Description
im.chat.mute	Disables notifications from the chat
im.dialog.read.all	Marks all chats as "read"
im.recent.hide	Removes a chat from the recent list
im.recent.pin	Pins a chat in favorites
im.recent.unread	Marks or unmarks a chat as "read"

Users

Method	Description
im.user.get	Retrieves user data
im.user.list.get	Retrieves user data
im.user.status.get	Retrieves information about the user's current status
im.user.status.idle.end	Disables the automatic "Away" status
im.user.status.idle.start	Sets the automatic "Away" status
im.user.status.set	Sets the user's status

Previous

Delete Additional Property

Next