Users in Chats: Overview of Methods

To work with users in chats, use the group of methods im.user.*.

Quick navigation: all methods

Relationship of Methods with Other ObjectsRelationship of Methods with Other Objects

User. The methods retrieve information about users by the identifier ID. You can find the chat user identifiers using the method im.chat.user.list.

User InformationUser Information

The method im.user.get retrieves information about the current user or a specific user if the ID parameter is filled in.

To get information about multiple users, you can use the method im.user.list.get. In the ID parameter, pass an array with user identifiers, for example, ID: [3,5,7].

User Status in ChatsUser Status in Chats

The method im.user.status.set sets the user's status in the chat:

• online — the user receives all notifications,

• dnd — Do Not Disturb mode, the user does not receive notifications about new messages.

You can find out the status using the method im.user.status.get.

The methods work only for the current user.

Overview of MethodsOverview of Methods

Scope: im

Who can execute the method: any user

Method	Description
im.user.get	Retrieves user data
im.user.list.get	Retrieves data about the list of users
im.user.status.set	Sets the user's status in the chat
im.user.status.get	Retrieves information about the user's set status

Methods for the Previous Version of the ChatMethods for the Previous Version of the Chat

The 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.

Method	Description
im.user.status.idle.start	Sets the automatic status Away
im.user.status.idle.end	Disables the automatic status Away