Messaging

Prev Next

Rocket.Chat provides a set of messaging APIs that allow you to create, manage, and retrieve messages across rooms and direct conversations. This section offers a high-level overview of the available messaging capabilities before you explore individual endpoints.

Chat API

Use the Chat API to manage messages in public and private rooms.

Capabilities:

  • Create, update, and delete messages in rooms.

  • Retrieve messages along with their metadata and engagement details.

  • Perform message actions, including following, pinning, starring, and reporting.

Direct Messages API

Use the Direct Messages API to manage private conversations between users.

Capabilities:

  • Create and close direct message (DM) rooms.

  • Retrieve the list of DM rooms and their messages within a workspace.

DM and IM endpoint equivalence

The dm.* and im.* endpoint groups provide identical functionality. For example, the dm.close and im.close endpoints perform the same operation. You can use either group based on your implementation preference.

  • The actions and information you can view depend on your role and the workspace configurations.

  • For detailed information about message properties and supported fields, see the Message schema definition.