Create Room

post deprecated

https://{base_url}/rest/room/create

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 directCall parameter indicates the type of link provided by the endpoint. If directCall is true, the user will have direct access to the call. The user will not see the Kaleyra landing page with information about invited users and call options. Default is false.

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

Note: Within the sandbox server, calls won’t be registered even if indicated in the REST parameters. If you would like to try the recording option in sandbox, please contact us at 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.

Body Params

participants

array of objects

required

length between 2 and 25

Array of users who will participate in the call.

participants*

user_id

string

is_admin

boolean

tools

object

The tools parameter is included in the participants field.

By default, if no tools are provided (missing field), all the tools are enabled. If the tools field is defined but empty, all the tools are disabled.

user_id

string

is_admin

boolean

tools

object

The tools parameter is included in the participants field.

By default, if no tools are provided (missing field), all the tools are enabled. If the tools field is defined but empty, all the tools are disabled.

recording

boolean

Defaults to false

This param defines whether the room should be recorded or not.

recording_type

string

enum

Defaults to automatic

Can be automatic or manual

Allowed:

call_type

string

enum

Defaults to audio_video

This param defines type of the call. Allowed values are audio_only, audio_upgradable or audio_video.

Allowed:

live

boolean

Defaults to false

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

duration

integer

60 to 86400

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.

description

string

A textual description of the rest room created.

initiatorAlias

string

Room creator alias (a valid user alias).

call_action

object

Allow to specify a call action that trigger the ring phase for the participants.

Responses

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad request

401API key is either missing or invalid

422Validation Error