Endpoints
Authentication
Url | Short Description | Details Page |
---|---|---|
| Authenticate with username and password. | |
| Authenticate with facebook. | |
| Authenticate with google. | |
| Authenticate with twitter. | |
| Invalidate your REST API authentication token. | |
| Displays information about the authenticated user. |
User Management
Avatar
URL | Short Description | Details Page |
---|---|---|
| Fetch room avatar |
Users
URL | Short Description | Details Page |
---|---|---|
| Creates a new user | |
| Deletes an existing user | |
| Deletes your own user | |
| Gets the URL for a user’s avatar | |
| Sets user's active status | |
| Deactivates Idle users | |
| Gets a user's presence | |
| Retrieves information about a user | |
| Retrieves all of the users | |
| Registers users | |
| Resets avatar | |
| Sets avatar | |
| Gets a user's status | |
| Sets a user status | |
| Updates user | |
| Updates own basic information | |
| Creates a user authentication token | |
| Gets all preferences of the user | |
| Sets preferences of the user | |
| Sends an email to reset your password | |
| Suggestion of new username to user | |
| Generates Personal Access Token | |
| Regenerates a user's personal access token | |
| Gets the user’s personal access tokens | |
| Removes a personal access token | |
| Enables 2fa email | |
| Disables 2fa email | |
| Sends 2fa code | |
| Gets all connected users presence | |
| Requests the user's data for download | |
| Logs out other clients | |
| Lists the user whose names match a given pattern | |
| Removes other tokens | |
| Reset the E2E key for a user | |
| Reset the Two-factor authentication via TOTP | |
| Lists users teams | |
| Logs user out | |
| Report a user. |
LDAP
Url | Short Description | Details Page |
---|---|---|
| LDAP SyncNow |
Permissions
Url | Short Description | Details Page |
---|---|---|
| Lists permissions on the server. | |
| Edits permissions on the server. |
Roles
Url | Short Description | Details Page |
---|---|---|
| Lists all roles on the server | |
| Lists all roles on the server updated after a date | |
| Creates a new role | |
| Edits permissions on the server | |
| Retrieves users that belong to a role | |
| Updates an existing role in the system | |
| Deletes a role | |
| Unassigns a role from a user |
Rooms
Group
Url | Short Description | Details Page |
---|---|---|
| Adds all users to a private group | |
| Gives Leader role to a user in the current group | |
| Gives moderator role to a user in a group | |
| Gives owner role to a user in a group | |
| Archives a private group | |
| Removes a private group from the list of groups | |
| Retrieves group counters | |
| Creates a new private group | |
| Removes a private group | |
| Retrieves files from a private group | |
| Retrieves integrations assigned to the group | |
| Retrieves messages from a private group | |
| Retrieves information about a private group | |
| Adds a user to the private group | |
| Removes a user from a private group | |
| Removes the caller from the private group | |
| Lists private groups the caller is part of | |
| Lists all private groups | |
| Lists moderators of a group | |
| Retrieves users of a private group | |
| Retrieves users of a private group sorted by their most important room role | Link |
| Retrieves all group messages | |
| Lists online users of a group | |
| Adds the private group back to the list of groups | |
| Removes Leader role from a user in the current group | |
| Removes moderator role from a user in a group | |
| Removes owner role from a user in a group | |
| Changes the name of the private group | |
| Retrieves user's roles in the private group | |
| Sets a group's announcement | |
| Sets private group's custom fields | |
| Sets a private group's description | |
| Sets a private group's purpose | |
| Sets whether the room is read-only or not | |
| Sets a private group's topic | |
| Sets the type of room this group will be | |
| Unarchives a private group | |
| Sets the encryption for a group | |
| Converts a private group to a team |
Channels
These methods apply to public channels only. Use groups.*
methods for private channels.
URL | Short Description | Details Page |
---|---|---|
| Adds all users to a channel | |
| Gives Leader role to a user in the current channel | |
| Gives moderator role to a user in a channel | |
| Gives owner role to a user in a channel | |
| Gets messages in public channels for an anonymous user | |
| Archives a channel | |
| Removes a channel from a user's list | |
| Retrieves channel counters | |
| Creates a new channel | |
| Removes a channel | |
| Retrieves mentions of a channel | |
| Retrieves files from a channel | |
| Retrieves channel integrations | |
| Retrieves messages from a channel | |
| Gets channel information | |
| Adds a user to a channel | |
| Joins a channel | |
| Removes a user from a channel | |
| Removes the caller from a channel | |
| Retrieves all channels from the server | |
| Retrieves joined channels of the calling user | |
| Retrieves all channel users | |
| Retrieves all channel users sorted by their most important room role | Link |
| Retrieves all channel messages | |
| Lists all moderators of a channel | |
| Lists all online users of a channel | |
| Adds the channel back to the user's list | |
| Removes Leader role from a user in the current channel | |
| Removes moderator role from a user in a channel | |
| Removes owner role from a user in a channel | |
| Changes a channel's name | |
| Gets user's roles in the channel | |
| Sets a channel's announcement | |
| Sets a channel's custom fields | |
| Sets a channel's default status | |
| Sets a channel's description | |
| Sets the channel's join code | |
| Sets a channel's purpose | |
| Sets whether a channel is read-only or not | |
| Sets a channel's topic | |
| Sets the type of room the channel should be | |
| Unarchives a channel | |
| Converts channel to team |
Room
Url | Short Description | Details Page |
---|---|---|
| Retrieves all rooms (requires special permission). | |
| Cleans up a room's history, requires special permission. | |
| Creates a new discussion. | |
| Favorites/Unfavorites room. | |
| Retrieves rooms. | |
| Retrieves room's discussions. | |
| Gets info from a room. | |
| Leaves a room. | |
| Sets the notification settings of a specific channel. | |
| Uploads a message with the attached file. | |
| Retrieves all admin rooms | |
| Autocompletes private channel | |
| Autocompletes room name available for conversion to team | |
| Save the settings of a room | |
| Change the Archive state of a room. | |
| Export room to a file or email. |
Teams
Url | Short Description | Details Page |
---|---|---|
| Lists the public and private teams the caller is part of. | |
| Lists all of the teams and their information. | |
| Creates a new team. | |
| Converts team to channel. | |
| Adds rooms to the team. | |
| Removes a room from a team. | |
| Updates a room from a team, limited to permissions. | |
| Lists all rooms of the team. | |
| Lists only the team's rooms the user has joined. | |
| Retrieves all team members. | |
| Adds members to the team. | |
| Updates a team member's roles, limited to permissions. | |
| Removes a member from a team. | |
| Leaves a team. | |
| Gets a team's information. | |
| Removes a team. | |
| Lists the teams whose names match a given pattern. | |
| Updates an existing team (name and type). |
Directory
Url | Short Description | Details Page |
---|---|---|
| Searches by all users and channels available on server. |
Messaging
Chat
URL | Short Description | Details Page |
---|---|---|
| Deletes an existing chat message. | |
| Follows an existing chat message. | |
| Retrieves the deleted messages from a specific date. | |
| Retrieves the discussions of a room. | |
| Retrieves the mentioned messages. | |
| Retrieves a single chat message. | |
| Retrieves message read receipts. | |
| Retrieves pinned messages from a room. | |
| Retrieves snippet messages. | |
| Retrieves snippet message by id. | |
| Retrieves the starred messages. | |
| Retrieves thread's messages. | |
| Retrieves channel's threads. | |
| Ignores abuser from a chat. | |
| Pins a chat message to the message's channel. | |
| Posts a new chat message. | |
| Sets/unsets the user's reaction to an existing chat message. | |
| Reports a message. | |
| Searches for messages in a channel. | |
| Stars a chat message for the authenticated user. | |
| Sends a new chat message. | |
| Retrieves synced thread's messages. | |
| Retrieves thread's synced channel threads. | |
| Unfollows an existing chat message. | |
| Removes the pinned status of the provided chat message. | |
| Removes the star on the chat message for the authenticated user. | |
| Updates the text of the chat message. | |
| Syncs messages |
DM/IM
URL | Short Description | Details Page |
---|---|---|
| Removes a direct message session | |
| Removes a direct message from the list of messages | |
| Gets counters of direct messages | |
| Creates a direct message session | |
| Retrieves messages from a direct message | |
| Retrieves a list of files from a direct message | |
| Retrieves participants of a direct message | |
| Retrieves messages from specific direct messages | |
| Retrieves messages from any direct message | |
| Lists direct messages the caller is part of | |
| Lists all direct messages to the caller | |
| Adds direct message back to the list of messages | |
| Sets a direct message topic |
From version 0.50.0 and on, you can call the methods using dm
instead of im
.
Omnichannel
Livechat
Livechat Agent
Url | Short Description | Details Page |
---|---|---|
| Retrieves the current omnichannel agent data | |
| Retrieves the data of the next available agent |
Livechat Configuration
Url | Short Description | Details Page |
---|---|---|
| Retrieves LiveChat widget configuration info and additional visitor data. |
Livechat Contacts
Url | Short Description | Details Page |
---|---|---|
| Registers a guest user as a new omnichannel contact | |
| Retrieves a contact information | |
| Searches a contact information |
Livechat Custom Field
Url | Short Description | Details Page |
---|---|---|
| Sends a custom field | |
| Sends an array of custom field | |
| Retrieves a list of omnichannel custom fields | |
| Retrieves info about a custom field |
Livechat Message
Url | Short Description | Details Page |
---|---|---|
| Sends a new omnichannel message | |
| Retrieves a specific message | |
| Updates an omnichannel message | |
| Removes an omnichannel message | |
| Retrieves omnichannel messages history | |
| Sends array of messages |
Livechat Offline Message
Url | Short Description | Details Page |
---|---|---|
| Sends an offline message when no agent is available |
Livechat Page Visited
Url | Short Description | Details Page |
---|---|---|
| Retrieves the pages your omnichannel user navigated on your website. |
Livechat Room
Url | Short Description | Details Page |
---|---|---|
| Retrievesthe omnichannel room data or open a new conversation. | |
| Closes an omnichannel conversation | |
| Transfers an omnichannel conversation | |
| Chatbot agent forwards the chat to a human agent | |
| Updates room visitor's information | |
| Update a LiveChat room information. |
Livechat Transcript
Url | Short Description | Details Page |
---|---|---|
| Send Livechat Transcript to Visitor | |
| Request Livechat transcript | |
| Delete Livechat Transcript Request | |
| Request PDF Transcript |
Livechat Transfer
Url | Short Description | Details Page |
---|---|---|
| Retrieves the conversation transfer history |
Livechat Visitor
Url | Short Description | Details Page |
---|---|---|
| Registers a new visitor | |
| Retrieves a visitor | |
| Deletes a visitor | |
| Retrieves open conversation of a visitor | |
| Sets visitor status |
Livechat Agent Stats
Url | Short Description | Details Page |
---|---|---|
| Returns all the departments associated with an agent | |
| Retrieves average service time per agent | |
| Retrieves total service time sorted by agent | |
| Retrieves a list of agents and their available time for the provided time frame |
Livechat Appearance
Url | Short Description | Details Page |
---|---|---|
| Retrieves LiveChat widget appearance settings | |
| Update Livechat widget appearance settings. |
Livechat Statistics
Url | Short Description | Details Page |
---|---|---|
| Get omnichannel analytics overview | |
| Get Agent Analytics Overview |
Livechat Business Hours
Url | Short Description | Details Page |
---|---|---|
| Fetches the default business hours of a workspace | |
| Retrieves all the business hours attached to a workspace | |
| Retrieves a list of existing business hours |
Livechat Dashboards
Url | Short Description | Details Page |
---|---|---|
| Retrieves conversation totalizers for a department | |
| Retrieves agent productivity totalizer for a department | |
| Retrieves chat totalizers for a department | |
| Retrieves productivity totalizers for a department | |
| Retrieves chats chart for a department | |
| Retrieves chats per agent for a department chart | |
| Retrieves agent's statuses chart | |
| Retrieves chats per department chart | |
| Retrieves timing charts |
Livechat Departments
Url | Short Description | Details Page |
---|---|---|
| Retrieves a list of departments | |
| Registers a new department | |
| Retrieves a department's info | |
| Updates a department | |
| Removes a department | |
| Autocompletes department name | |
| Retrieves agents of a specific department | |
| Updates agents of a department | |
| Retrieves a list of departments by an array of department ids | |
| Retrieves departments available by unit Id | |
| Retrieves the number of incoming chats | |
| Retrieves average service time | |
| Retrieves average chats duration | |
| Retrieves total service time | |
| Retrieves avg waiting time | |
| Retrieves total transferred chats | |
| Retrieves abandoned chats | |
| Retrieves percentage of abandoned chats |
Livechat Inquiries
Url | Short Description | Details Page |
---|---|---|
| Lists all of the open livechat inquiries | |
| Takes an open inquiry | |
| Lists queued inquiries | |
| Gets one inquiry by room id | |
| Set SLA to an inquiry. |
Livechat Integrations
Url | Short Description | Details Page |
---|---|---|
| Retrieves a list of integration settings |
Livechat Queue
Url | Short Description | Details Page |
---|---|---|
| Retrieves the queued chats |
Livechat Rooms
Url | Short Description | Details Page |
---|---|---|
| Retrieves a list of livechat rooms | |
| Set the priority of a Livechat room. | |
| Remove the priority set to a Livechat room. | |
| Puts an active livechat conversation on hold |
Livechat SMS
Url | Short Description | Details Page |
---|---|---|
| Receives SMS |
Livechat Triggers
Url | Short Description | Details Page |
---|---|---|
| Lists all Livechat triggers | |
| Retrieves a Livechat Trigger by id |
Livechat Upload
Url | Short Description | Details Page |
---|---|---|
| Uploads files on livechat room. |
Livechat Users
Url | Short Description | Details Page |
---|---|---|
| Gets a list of agents or managers | |
| Registers a new agent or manager | |
| Gets info about an agent or manager | |
| Removes an agent or manager |
Livechat Visitors
Url | Short Description | Details Page |
---|---|---|
| Retrieves visitor info by ID | |
| Retrieves pages visited by livechat visitor | |
| Retrieves livechat visitor's chat history | |
| Searches a visitor's chat | |
| Autocompletes visitor's name | |
| Searches the visitor by the term |
Livechat Monitors
Url | Short Description | Details Page |
---|---|---|
| List all monitors | |
| Get a Monitor |
Livechat Priorities
Url | Short Description | Details Page |
---|---|---|
| Get priorities | |
| Get a priority | |
| Update the priority | |
| Reset the priority |
Livechat Tags
Url | Short Description | Details Page |
---|---|---|
| Retrieves a list of tags | |
| Get a tag. |
Livechat Units
Url | Short Description | Details Page |
---|---|---|
| Create unit | |
| List all omnichannel units. | |
| Retrieves details of a unit | |
| List unit monitors | |
| Update Unit by Id | |
| Delete unit using ID |
Voice Channel
URL | Description | Details Page |
---|---|---|
| Get registration information by ID | |
| Get VoIP query summary data | |
| Get VoIP query summary data | |
| Get VoIP queue membership data | |
| Get VoIP queue membership subscription data | |
| Get VoIP queue membership subscription data | |
| Get the VoIP queue membership subscription data | |
| Create a VoIP visitor | |
| Send VoIP events | |
| Retrieve VoIP extension information | |
| Retrieve VoIP extensions | |
| Create, update and delete VoIP extension | |
| Check management server connection status | |
| Check call server connection status | |
| Create VoIP room | |
| Retrieve VoIP room information by ID | |
| Close the VoIP conversation |
Canned Response
URL | Short Description | Details Page |
---|---|---|
| Create a canned response. | |
| Update a canned response. | |
| Get a canned response | |
| List all canned responses | |
| Get user canned responses | |
| Remove a canned response |
Integrations
Integration
Url | Short Description | Details Page |
---|---|---|
| Creates an integration. | |
| Gets an integration. | |
| Lists all history of the specified integration. | |
| Lists all of the integrations. | |
| Removes an integration. | |
| Updates an integration. |
Webdav
URL | Short Description | Details Page |
---|---|---|
| Retrieves the user's webdav accounts |
OAuth App
Url | Short Description | Details Page |
---|---|---|
| Retrieves an OAuth App by id or client id. | |
| Retrieves a list of OAuth Apps. |
Notifications
Banners
URL | Short Description | Details Page |
---|---|---|
| Gets the banners to be shown to the authenticated user | |
| Gets the banners to be shown to the authenticated user | |
| Dismisses a banner |
Push
Url | Short Description | Details Page |
---|---|---|
| Saves push token. | |
| Removes push token. | |
| Get push notification for a message |
Content Management
Assets
URL | Short Description | Details Page |
---|---|---|
| Sets an asset image by name. | |
| Unsets an asset by name. |
Custom Emoji
Url | Short Description | Details Page |
---|---|---|
| Retrieves all custom emojis | |
| Retrieves an updated list of custom emojis | |
| Creates new custom emoji. | |
| Delete an existent custom emoji. | |
| Updates an existent custom emoji. |
Custom Sounds
URL | Short Description | Details Page |
---|---|---|
| Retrieves a list of custom sounds. |
Custom User Status
URL | Short Description | Details Page |
---|---|---|
| Lists all available custom user's status. | |
| Creates custom user status | |
| Deletes a custom user status | |
| Updates a custom user status |
Statistics
Stats
URL | Short Description | Details Page |
---|---|---|
| Retrieves statistics | |
| Retrieves statistics list |
Engagement Dashboard
Users Engagement Dashboard Endpoints
Url | Short Description | Details Page |
---|---|---|
| List new users during a specific period | |
| List active users in the workspace | |
| List users by hours at a particular time of the day in a week | |
| Get hourly data when chat is busier | |
| Get weekly data when chat is busier |
Messages Engagement Dashboard Endpoints
URL | Short Description | Details Page |
---|---|---|
| Get number of daily messages sent during a period | |
| Get origin of messages sent during a period | |
| Get top 5 popular channels by message count |
Channels Engagement Dashboard Endpoints
URL | Short Description | Details Page |
---|---|---|
| Get all channels and the number of messages in each |
Subscription
Url | Short Description | Details Page |
---|---|---|
| Retrieves all subscriptions. | |
| Retrieves the subscription by room Id. | |
| Marks a room as read. | |
| Marks messages as unread. |
Settings
Settings
You can get and update the settings via the REST API, only if you have permission to.
Url | Short Description | Details Page |
---|---|---|
| Lists all private settings. | |
| Lists all public settings. | |
| Returns list of all available oauth services. | |
| Lists all service configurations. | |
| Retrieves a setting. | |
| Updates a setting. |
Cloud
URL | Short Description | Details Page |
---|---|---|
| Manually registers a workspace |
DNS
URL | Short Description | Details Page |
---|---|---|
| Resolves DNS srv records (SRV records) for a hostname | |
| Resolves DNS text records (TXT records) for a hostname |
E2E
URL | Short Description | Details Page |
---|---|---|
| Retrieves E2E keys of logged in user | |
| Retrieves Users Of Room Without E2E Key | |
| Sets the end-to-end encryption key ID for a room | |
| Sets the end-to-end encryption keys for the authenticated user. | |
| Updates the end-to-end encryption key for a user in a room. |
Imports
URL | Short Description | Details Page |
---|---|---|
| Upload import file. | |
| Download public import file. | |
| Start import. | |
| Get file data of an upload. | |
| Get the progress of an import. | |
| Get latest import operations | |
| Download pending files | |
| Download pending avatars | |
| Gets current import operations |
Bulk User Import
Url | Short Description | Details Page |
---|---|---|
| Adds user data to the import staging area. | |
| Abort any import operation currently in progress | |
| Process the data from the current import operation and create the users on Rocket.Chat | |
| Creates a new import operation. | |
| Get the status of the current import operation |
Instances
URL | Short Description | Details Page |
---|---|---|
| Retrieves instances |
Federation
Url | Short Description | Details Page |
---|---|---|
| Adds a server to search public rooms later | |
| Retrieves all the server names saved by the user | |
| Remove a server name | |
| Returns all the public room given a server name | |
| Joins an External public Matrix room |
Device Management
URL | Short Description | Details Page |
---|---|---|
| Retrieves all sessions of the authenticated user | |
| Retrieve the sessions of all users on the workspace | |
| Get user's session | |
| Logout the authenticated user from the current session | |
| Logout of a session |
Auto Translate
URL | Short Description | Details Page |
---|---|---|
| Gets the supported languages by auto-translate. | |
| Saves some settings about auto-translate. | |
| Translates the message. |
Commands
URL | Short Description | Details Page |
---|---|---|
| Retrieves the specification of the slash command. | |
| Lists all available slash commands. | |
| Executes a slash command in the specified room. | |
| Retrieves the preview data for the command and executes the preview item. | |
| Executes command's preview item |
Email Inbox
URL | Short Description | Details Page |
---|---|---|
| Retrieves mail Inbox list | |
| Sets the email inbox for your server | |
| Retrieves email Inbox by id | |
| Delete email inbox using id | |
| Searches email inbox by address | |
| Sends test email to email inbox |
Invite
Url | Short Description | Details Page |
---|---|---|
| Created a new Invite or returns an existing one with the same parameters. | |
| Lists all of the invite tokens. | |
| Deletes an invite from the server. | |
| Reports to the server that an invite token was used. | |
| Checks if an invite token is valid. |
Licenses
Url | Short Description | Details Page |
---|---|---|
| Gets all registered licenses. | |
| Confirm if workspace has enterprise license. | |
| Get maximum active users. |
Video conference
URL | Short Description | Details Page |
---|---|---|
| Updates the timeout of Jitsi video conference in a channel. |
Others
URL | Short Description | Details Page |
---|---|---|
| Install a private app via URL | |
| Get the the shield svg(badge) | |
| Searches for users or rooms that are visible to the user | |
| Retrieves last 1000 lines of server logs |
WhatsApp
Description | Details Page |
---|---|
WhatsApp Business API integration for Rocket.Chat | |
Send a template message. |
Mailer
URL | Short Description | Details Page |
---|---|---|
| Send an email to users on your workspace. | |
| Unsubscribe from mailer |
Moderation
Url | Short Description | Details Page |
---|---|---|
| Retrieves all the reported messages grouped by users | |
| Retrieve all reported messages of a user. | |
| Retrieve all the reports of a single message | |
| Get more details of a single report. | |
| Dismiss all the reports of a particular user. | |
| Delete all the reports of messages that belongs to user. |
Last updated