Video Conference

Use the Video Conference API to integrate and manage video calling within your workspace. These endpoints allow you to configure supported providers, initiate and join meetings, retrieve call details, and cancel active sessions.

With the Video Conference API, you can:

• View available video providers configured for your workspace.

• Retrieve video call details for monitoring and coordination.

• Start and join video calls programmatically.

• Cancel active calls when they are no longer needed.

Ensure that a video call provider is installed and configured before using these endpoints. For setup instructions, see the Conference Call user guide.

The video conference object

Video conference endpoints return a conference object. A trimmed example from Get Video Conference Details:

{
  "_id": "697866d5c8b053302078137a",
  "type": "videoconference",
  "title": "testdiscussion",
  "rid": "68c8071650223764573dd2dc",
  "status": 1,
  "ringing": true,
  "providerName": "googlemeet",
  "url": "http://g.co/meet/RocketChat_697866d5c8b053302078137a",
  "users": [
    { "_id": "fRv4qm8ycWHXSA7af", "username": "jane.doe", "ts": "2026-01-27T07:18:46.491Z" }
  ],
  "createdBy": { "_id": "fRv4qm8ycWHXSA7af", "username": "jane.doe" },
  "capabilities": { "mic": false, "cam": false, "title": false },
  "success": true
}

Fields you use most often:

• _id: The conference ID, passed as callId in most endpoints.

• rid: The room the call belongs to.

• providerName and url: Which provider app runs the call and the link to join it.

• users: The conference members, with per-member status fields such as joined, declined, and leftAt.

• capabilities: What the provider supports, such as mic, cam, and renaming the call title.

Common workflows

Start and run a call

1. Start the video conference in a room to get its callId and join url.

2. Ring a member or add participants; each member joins or declines the call.

3. Members leave the call when done, or cancel the conference to end it.

Check what the workspace supports

1. Get the configured providers.

2. Get the capabilities to see whether mic, camera, and call titles are supported.

Monitor and manage calls

1. List a room's video conferences or the calls you can join, then get a call's details by its callId.

2. Rename the call, or share the call chat with conference members who cannot read it (see chatAccess.membersWithoutAccess).

3. While in a call, clients renew the member's presence so their status stays accurate.

Conventions

• Endpoints reference a call by callId , the conference object's _id and every conference belongs to a room (rid).

• Calls run through a provider app (such as Jitsi or Google Meet); what you can do depends on the provider's capabilities.

• A member's presence in the call is heartbeat-based: if a client stops renewing presence, the member is recorded as having left with leftReason: "timeout".

• Some endpoints are rate limited  for example, Get Video Conference Details allows 15 requests per 3000 ms. Each endpoint page states its limits.