Users in Chats: Overview of Methods
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.
To work with users in chats, use the group of methods im.user.*. They return the data the way the messenger shows it: the display name, avatar, color, status in the chat, the time of the last activity, and the flags of a bot, an external user, or an Open Channel user. The subsection is part of the Chats in Bitrix24 section.
The im.user.* methods are current and have no im.v2 counterparts. The exception is the automatic Away status methods — they are placed in a separate group, Methods for the Previous Version of the Chat.
Quick navigation: all methods
User documentation: Chats in Bitrix24: Interface and Capabilities
How to Choose a Method
|
If You Need To |
Method |
|
The data of the current user or of one employee |
|
|
The data of several users at once |
|
|
Set your own status in the messenger |
|
|
Read your own status |
|
|
Find an employee by name, position, or department |
im.search.user.list from the Search subsection |
|
Retrieve the participants of a specific chat with their data |
im.dialog.users.list from the Chat Participants subsection |
|
The full employee profile: contacts, departments, custom fields |
The methods of the Users section |
Relationship of Methods with Other Objects
User. The methods retrieve information about users by the identifier ID. You can find the chat participant identifiers using the im.chat.user.list method. The same identifier is returned by the user.get and user.search methods: in Bitrix24, a user has a single identifier for all methods.
Departments. You can retrieve the identifiers of employees and managers by the company structure with the methods of the Departments subsection.
Extranet. An extranet user has access only to the members of their extranet groups. In this case, the im.user.get method returns the ACCESS_DENIED error, while im.user.list.get silently skips the unavailable identifiers.
User Status in Chats
The user status controls notifications and is displayed in the messenger. The im.user.status.set and im.user.status.get methods work only for the current user: you cannot set or read the status of another employee.
The im.user.status.set method accepts four values: online, dnd, away, and break. In the interface of the current chat version, only online is displayed — the other statuses are set but not shown.
User Documentation
Overview of Methods
Scope:
imWho can execute the method: any user
|
Method |
Description |
|
Retrieves user data |
|
|
Retrieves data about the list of users |
|
|
Sets the user's status in the chat |
|
|
Retrieves the user's set status |
Methods for the Previous Version of the Chat
The automatic Away status methods were designed for the previous version of the chat. In the current version of chat M1, they work, but the results are not displayed in the interface. They have no replacement in the current version and are not suitable for new development.
User Documentation
|
Method |
Description |
|
Sets the automatic status Away |
|
|
Disables the automatic status Away |