Get Video Conference Capabilities

Prev Next
Get
/api/v1/video-conference.capabilities

Get details on the video call capabilities, such as the name of the provider, and whether Rocket.Chat can control the microphone and camera state. This endpoint is used for the video conference system to dynamically adapt the UI based on provider capabilities, ensuring users only see controls that are actually supported by the configured video conference provider.

Rate limiting: 3 requests per 1000ms

Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Responses
200

OK

Example 1
{
  "providerName": "googlemeet",
  "capabilities": {
    "mic": false,
    "cam": false,
    "title": false
  },
  "success": true
}
Example 2
{
  "providerName": "jitsi",
  "capabilities": {
    "mic": true,
    "cam": true,
    "title": true
  },
  "success": true
}
Expand All
object
providerName
string
capabilities
object
mic
boolean
cam
boolean
title
boolean
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "no-active-video-conf-provider"
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string