/meetings

Creates a transient room that is available between creation and an hour after the given endDate. After this time the room will be automatically deleted. The URL to this room is present in the response.

Create meeting

Creates a transient room that is available between creation and an hour after the given end date. After this time the room will be automatically deleted. The URL to this room is present in the response.

POSThttps://api.whereby.dev/v1/meetings

Body

application/json

Meeting to add.

endDate*string (date-time)

When the meeting ends. By default in UTC but a timezone can be specified, e.g. 2021-05-07T17:42:49-05:00. This has to be the same or after the current date.

isLockedboolean

The initial lock state of the room. If true, only hosts will be able to let in other participants and change lock state.

roomModeenum

The mode and size of the created transient room. normal is the default room mode and should be used for meetings up to 4 participants. group should be used for meetings that require more than 4 participants.

Example: "group"

groupnormal

roomNamePrefixstring

This will be used as the prefix for the room name. The string should be lowercase, and spaces will be automatically removed. 39 character max

Example: "example-prefix"

Pattern: [a-z0-9]{0,39}

roomNamePatternenum

The format of the randomly generated room name. uuid is the default room name pattern and follows the usual 8-4-4-4-12 pattern. human-short generates a shorter string made up of six distinguishable characters.

Example: "uuid"

uuidhuman-short

templateTypeenum

If provided, the room will be created with the given template type. Each template defines a set of properties needed for a particular use-case. Currently the only supported template type is "viewerMode". This will set up a room with properties that are needed to create a viewer mode room. The room will be locked, roomMode set to "group" and fields like hostRoomUrl and viewerRoomUrl will be added to the response.

viewerMode

recordingobject

Options for how a meeting should be recorded.

liveTranscriptionobject

A configuration object for Session Transcription

streamingobject

A configuration object for live RTMP streaming of the meeting

fieldsFields (array of enum)

Additional fields that should be populated.

• hostRoomUrl - Include hostRoomUrl field in the meeting response.
• viewerRoomUrl - Include viewerRoomUrl field in the meeting response.

Response

201401403429

The resource was created successfully.

Body

application/json

meetingId*string

The ID of the meeting.

roomNamestring

The name of the room.

Example: "/4b3bd908-cb88-11ec-9d64-0242ac120002"

roomUrl*string (uri)

The URL to room where the meeting will be hosted.

startDatestring (date-time)

When the meeting starts. Always in UTC, regardless of the input timezone.

endDate*string (date-time)

When the meeting ends. Always in UTC, regardless of the input timezone.

hostRoomUrlstring (uri)

The URL to the room where the meeting will be hosted which will also make the user the host of the meeting. A host will get additional privileges like locking the room, and removing and muting participants, so you should be careful with whom you share this URL. The user will only become a host if the meeting is on-going (some additional slack is added to allow a host joining the meeting ahead of time or if the meeting goes over time). This field is optional and will only be returned if requested through the fields parameter.

viewerRoomUrlstring (uri)

The URL to the room where the meeting will be hosted which will make the user a viewer of the meeting. A viewer will not be able to turn on the camera or microphone, but will be able to join the meeting. This field is optional and will only be returned if requested through the fields parameter.

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/meetings', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "endDate": "2024-11-21T06:30:01.772Z"
    }),
});
const data = await response.json();

Response

201429

{
  "meetingId": "1",
  "startDate": "2020-05-12T16:42:49Z",
  "endDate": "2020-05-12T17:42:49Z",
  "roomUrl": "https://subdomain.whereby.com/dda1beca-af37-11eb-ac88-372b6869f077"
}

Get meetings

Returns a list of meetings.

GEThttps://api.whereby.dev/v1/meetings

Query parameters

Response

200401404429

A JSON object with the page containing the array with the meetings results.

Body

application/json

results*array of Meeting (object)

cursor*string

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request. If there are no more results, the value returned is null.

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/meetings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

{
  "results": [
    {
      "meetingId": "1",
      "startDate": "2020-05-12T16:42:49Z",
      "endDate": "2020-05-12T17:42:49Z",
      "roomUrl": "https://subdomain.whereby.com/dda1beca-af37-11eb-ac88-372b6869f077"
    }
  ],
  "cursor": "text"
}

Get meeting

Returns the specified meeting.

GEThttps://api.whereby.dev/v1/meetings/{meetingId}

Path parameters

meetingId*any

meeting ID.

Example: "1"

Query parameters

Response

200401404429

A JSON object representing the meeting.

Body

application/json

meetingId*string

The ID of the meeting.

roomNamestring

The name of the room.

Example: "/4b3bd908-cb88-11ec-9d64-0242ac120002"

roomUrl*string (uri)

The URL to room where the meeting will be hosted.

startDatestring (date-time)

When the meeting starts. Always in UTC, regardless of the input timezone.

endDate*string (date-time)

When the meeting ends. Always in UTC, regardless of the input timezone.

hostRoomUrlstring (uri)

The URL to the room where the meeting will be hosted which will also make the user the host of the meeting. A host will get additional privileges like locking the room, and removing and muting participants, so you should be careful with whom you share this URL. The user will only become a host if the meeting is on-going (some additional slack is added to allow a host joining the meeting ahead of time or if the meeting goes over time). This field is optional and will only be returned if requested through the fields parameter.

viewerRoomUrlstring (uri)

The URL to the room where the meeting will be hosted which will make the user a viewer of the meeting. A viewer will not be able to turn on the camera or microphone, but will be able to join the meeting. This field is optional and will only be returned if requested through the fields parameter.

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/meetings/{meetingId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

{
  "meetingId": "1",
  "startDate": "2020-05-12T16:42:49Z",
  "endDate": "2020-05-12T17:42:49Z",
  "roomUrl": "https://subdomain.whereby.com/dda1beca-af37-11eb-ac88-372b6869f077"
}

Delete meeting

Deletes the specified meeting. The endpoint is idempotent, meaning it will return the same response even if the meeting has already been deleted.

DELETEhttps://api.whereby.dev/v1/meetings/{meetingId}

Path parameters

meetingId*any

meeting ID.

Example: "1"

Response

204401429

The resource was deleted successfully.

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/meetings/{meetingId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}