/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.

Last updated 3 months ago

Was this helpful?

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.

post

/meetings

Body

endDatestring · date-timerequired

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.

startDatestring · date-timeDeprecated

(DEPRECATED - value is ignored) Start time now defaults to time of request

isLockedboolean

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

roomNamePrefixstring · max: 39

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}

fieldsstring · enum[]

Additional fields that should be populated.

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

roomModestring · enum · default: normal

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

Options: group, normal

roomNamePatternstring · enum · default: uuid

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

Options: uuid, human-short

templateTypestring · enum

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.

Options: viewerMode

streamingobject

A configuration object for live RTMP streaming of the meeting

recordingobject

Options for how a meeting should be recorded.

liveTranscriptionobject

A configuration object for Session Transcription

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.whereby.dev/v1/meetings' \
  --header 'Content-Type: application/json' \
  --data '{"endDate":"2025-02-21T18:14:24.105Z","roomNamePrefix":"example-prefix","fields":["hostRoomUrl"],"roomMode":"group","roomNamePattern":"uuid","templateType":"viewerMode","streaming":{"startTrigger":"none","destination":{"url":"text"}},"recording":{"type":"none","startTrigger":"none","destination":{"provider":"s3","fileFormat":"mkv"}},"liveTranscription":{"startTrigger":"none","language":"ca,","destination":{"provider":"s3"}}}'

201

401

403

429

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

The resource was created successfully.

Get meetings

Returns a list of meetings.

get

/meetings

Query parameters

cursorstring

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request.

Example: 8f4031bfc7640c5f267b11b6fe0c2507

limitinteger · min: 1 · max: 100 · default: 50

The limit for the pagination - the maximum number of results that will be returned within a single API response.

fieldsstring · enum[]

Additional fields that should be populated.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.whereby.dev/v1/meetings'

200

401

404

429

{
  "cursor": "text",
  "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"
    }
  ]
}

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

Get meeting

Returns the specified meeting.

get

/meetings/{meetingId}

Path parameters

meetingIdanyrequired

meeting ID.

Example: 1

Query parameters

fieldsstring · enum[]

Additional fields that should be populated.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.whereby.dev/v1/meetings/{meetingId}'

200

401

404

429

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

A JSON object representing the meeting.

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.

delete

/meetings/{meetingId}

Path parameters

meetingIdanyrequired

meeting ID.

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.whereby.dev/v1/meetings/{meetingId}'

204

401

429

No body

The resource was deleted successfully.