Start Video Conference

Prev Next
Post
/api/v1/video-conference.start

Use this endpoint to begin a video call in a specific room. Rate limiting: 3 requests per 60000ms. Permission required: call-management.

Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Body parameters
Example 1
{
  "roomId": "674eca3e43725ce31dd9a2e8",
  "title": "Test Call",
  "allowRinging": true
}
object
roomId
string Required

Enter the room ID where you want to start the video call.

Example674eca3e43725ce31dd9a2e8
title
string

Enter a title for the video call.

allowRinging
boolean

Whether to enable ringing for direct calls (requires videoconf-ring-users permission; by default admin, users, moderators, and owners have this permission).

Responses
200

OK

Example 1
{
  "data": {
    "type": "videoconference",
    "callId": "697887e3c8b0533020781a4a",
    "rid": "674eca3e43725ce31dd9a2e8",
    "providerName": "googlemeet"
  },
  "success": true
}
Expand All
object
data
object
type
string
callId
string
rid
string
providerName
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'roomId' [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