Get
/api/v1/video-conference.info
Get details about a specific video conference. Rate limiting: 15 requests per 3000ms.
Header parameters
X-User-Id
stringRequired
The user ID.
ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired
The authentication token.
Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Query parameters
callId
stringRequired
Enter the call ID.
Example697866d5c8b053302078137a
Responses
200
OK
Example 1
{
"_id": "697866d5c8b053302078137a",
"type": "videoconference",
"users": [
{
"_id": "fRv4qm8ycWHXSA7af",
"username": "jane.doe",
"name": "jane",
"avatarETag": null,
"ts": "2026-01-27T07:18:46.491Z"
}
],
"messages": {
"started": "RdiQLFktbFxtK2XTZ"
},
"status": 1,
"anonymousUsers": 0,
"createdAt": "2026-01-27T07:18:45.956Z",
"providerName": "googlemeet",
"ringing": true,
"title": "testdiscussion",
"rid": "68c8071650223764573dd2dc",
"createdBy": {
"_id": "fRv4qm8ycWHXSA7af",
"name": "jane",
"username": "jane.doe"
},
"_updatedAt": "2026-01-27T07:18:46.491Z",
"url": "http://g.co/meet/RocketChat_697866d5c8b053302078137a",
"capabilities": {
"mic": false,
"cam": false,
"title": false
},
"success": true
}object
_id
string
type
string
users
Array of object
object
_id
string
username
string
name
string
avatarETag
string
ts
string
messages
object
started
string
status
integer
anonymousUsers
integer
createdAt
string
providerName
string
ringing
boolean
title
string
rid
string
createdBy
object
_id
string
name
string
username
string
_updatedAt
string
url
string
capabilities
object
mic
boolean
cam
boolean
title
boolean
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'callId' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string