KAkaleyra
Room

Get room

Get a room by its Id.

get/v2/rooms/{room_id}

Request

  • Base URL
    https://api.sandbox.eu.bandyer.com
  • URL
    https://api.sandbox.eu.bandyer.com/v2/rooms/{room_id}
  • Auth
    API key in header apikey

Path parameters

room_idstring required

Room id

Response

idstring

Room id.

recording'none' | 'manual' | 'automatic'

Type of recording.

call_type'audio_only' | 'audio_upgradable' | 'audio_video'

Call type.

descriptionstring

Room description. This field is treated as PII/PHI

status'NOT_RUNNING' | 'RUNNING' | 'CLOSED'

Status of the room.

disabledboolean

Indicates if a room is disabled or not.

creation_datestring date-time

Creation date of the room.

durationinteger

Duration of the room.

liveboolean

Indicates if the room is live or not.

offline_transcriptionboolean

Indicates if the room has transcription or not.

summarizationboolean

Indicates if the room has summarization or not.

Example response

{
  "creation_date": "2023-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.