Create room

post

https://{base_url}/v2/rooms

Create a room

The duration parameter indicates the maximum duration of the call. It is expressed in seconds. If the parameter is not specified, the call has unlimited duration. The minimum duration is 60 seconds.

The response returns the URLs that each user can use to join the call.

NOTE: Within the sandbox server, the calls won’t be recorded even if indicated in the REST parameters. If you would like to try the recording option in sandbox, please contact support.

NOTE: 30 seconds before the time is up all clients get notifications of the short time left. When the duration expires the call ends. Available time runs only when clients are in the videocall. If they are experiencing problems and the connection drops, the timer will stop.

NOTE: If you have enabled WebHooks (described in Web Hooks section), the room_id returned in the response, could be saved in your database for further hook events that might be received.

NOTE: if Offline transcription is not currently enabled for your Company. Please contact support to activate this feature.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

recording

string

enum

Default value is "none"

Allowed:

duration

integer

Maximum value expressed in seconds of effective calling time allowed for the room. The minimum value is 60 seconds. If not specified, the call duration is unlimited. With effective calling time is intended the sum of the time where the room is running with at least two connected users.

call_type

string

enum

Default value is "audio_video"

Allowed:

live

boolean

This param defines whether the usage of generated links triggers widget and mobile ringing or not. If set to true it also triggers the sending of the on_call_incoming webhook.

description

string

Description of the room. This field is treated as PII/PHI

participants

array of objects

required

Participants details of the room.

participants*

offline_transcription

boolean

Defaults to false

offline_transcription will only be available for rooms with 'recording' set to either 'automatic' or 'manual'. Transcription will begin once the recording ends.

NOTE: if offline transcription is not currently enabled for your Company. Please contact support to activate this feature.

summarization

boolean

Defaults to false

summarization will only be available for rooms with 'recording' set to either 'automatic' or 'manual' and 'offline_transcription' in true. Summarization will begin once the transcription ends.

NOTE: if summarization is not currently enabled for your Company. Please contact support to activate this feature.

Responses

201

401Unauthorized

422Unprocessable Content

429Too Many request