KAkaleyra
Room

Get all rooms

Get a list of rooms.

get/v2/rooms

Request

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

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The numbers of items to return

fromstring date-time

Date value only days in YYYY-MM-DD

tostring date-time

Date value only days in YYYY-MM-DD

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

Recording type of the room.

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

Call type.

liveboolean

Indicates if a room is live or not.

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

Status of a room.

disabledboolean

Indicates if a room is disabled or not.

user_idstring

Filters active rooms where that user_id is participating

Response

return list of Rooms

offsetinteger

The number of items to skiped before starting to collect the result set.

limitinteger

The numbers of items to returned.

has_moreboolean

Indicates is there more values.

countinteger

Total number of values returned.

Example response

{
  "rooms": [
    {
      "creation_date": "2023-01-01T00:00:00Z"
    }
  ]
}

Changes

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