Whereby (1.0.0)

Download OpenAPI specification:Download

Whereby API

Authentication

BearerAuth

The bearer token will be provided upon request and it is up to the client to keep it secret. Every api call needs to contain this token in order to authenticate and authorize the client.

Security scheme type: HTTP
HTTP Authorization Scheme bearer

Create meeting

Creates a meeting as specified. It will also create a transient room that is guaranteed to be available for specified start and end time. Some time after the meeting has ended, the transient room will be automatically deleted. The URL to this room is present in the response.

Request Body schema: application/json

Meeting to add.

roomNamePrefix
string <= 40 characters [/][a-zA-Z0-9]{0,39}

This will be used as the prefix for the room name. Note that the room name needs to start with / if it is provided.

roomMode
string
Default: "normal"
Enum:"group" "normal"

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

startDate
required
string <date-time>

When the meeting starts. This has to be newer than the current date.

endDate
required
string <date-time>

When the meeting ends. This has to be the same or after the startDate.

Responses

200

The resource was created successfully.

401

Access token is missing or invalid

post /meetings

Production server

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

Request samples

application/json
Copy
Expand all Collapse all
{
  • "roomNamePrefix": "/example-prefix",
  • "roomMode": "normal",
  • "startDate": "2019-08-14T10:00:22Z",
  • "endDate": "2019-08-14T10:00:22Z"
}

Response samples

application/json
Copy
Expand all Collapse all
{}

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.

path Parameters
meetingId
required
any
Example: "1"

meeting ID.

Responses

204

The resource was deleted successfully.

401

Access token is missing or invalid

delete /meetings/{meetingId}

Production server

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

Get meeting

Returns the specified meeting.

path Parameters
meetingId
required
any
Example: "1"

meeting ID.

Responses

200

A JSON object representing the meeting.

401

Access token is missing or invalid

404

The requested resource doesn't exist

get /meetings/{meetingId}

Production server

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

Response samples

application/json
Copy
Expand all Collapse all
{}