---
title: "Create room"
method: POST
path: "/v2/rooms"
tags: ["Room"]
---

# Create room

`POST /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.*

## Request body

- object
  - `recording` 'none' | 'manual' | 'automatic' — Default value is "none"
  - `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` 'audio_only' | 'audio_upgradable' | 'audio_video' — Default value is "audio_video"
  - `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` object[], required — Participants details of the room.
    - `user_id` string, required — User id of the participant.
    - `is_admin` boolean — Indicates if the participant is admin or not.
    - `tools` object
      - `chat` boolean — Enable the chat feature
      - `screen_sharing` boolean — Enable the screen_sharing feature
      - `file_upload` boolean — Enable the capability to send file
      - `snapshot` boolean — Enable the snapshot feature
      - `live_edit` boolean — Enable the live edit feature
      - `live_pointer` boolean — Enable to send pointer-events to others participants (always active in reception)
      - `present_to_everyone` boolean — Enable the capability to force your own video to be featured for other participants
      - `sign` boolean — If the user have the capability enabled, this flag allow to create a new sign process. Visit digital signature section for more information. (always active in reception).
      - `whiteboard` union — if true enable all the whiteboard tools. Can be an object of whiteboard tools
        - boolean
        - object
          - `wb_pen` boolean — Allows to using the pen on the whiteboard
          - `wb_eraser` boolean — Allows to erase a previous draw on the whiteboard
          - `wb_add_file` boolean — Allows to add files on the whiteboard
          - `wb_text` boolean — Allows to add text on the whiteboard
          - `wb_shape` boolean — Allows to add shape on the whiteboard
          - `wb_cursor` boolean — Allows to send the cursor events to the other participants
  - `offline_transcription` boolean — 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 — 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.*

## Response `201`

- object
  - `id` string — Room id.
  - `recording` 'none' | 'manual' | 'automatic' — Type of recording.
  - `call_type` 'audio_only' | 'audio_upgradable' | 'audio_video' — Call type.
  - `description` string — Room description. **This field is treated as PII/PHI**
  - `status` 'NOT_RUNNING' | 'RUNNING' | 'CLOSED' — Status of the room.
  - `disabled` boolean — Indicates if a room is disabled or not.
  - `creation_date` string, date-time — Creation date of the room.
  - `duration` integer — Duration of the room.
  - `live` boolean — Indicates if the room is live or not.
  - `offline_transcription` boolean — Indicates if the room has transcription or not.
  - `summarization` boolean — Indicates if the room has summarization or not.

## Other responses

- `401` — Unauthorized
- `422` — Unprocessable Content
- `429` — Too Many request

---

[API](https://skmtc.net/kaleyra/apis/kaleyra-io-sms-apis.md) · [All operations](https://skmtc.net/kaleyra/apis/kaleyra-io-sms-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kaleyra/kaleyra-io-sms-apis/versions/d9b785884d03/schema)