Room Sessions API

Rooms Sessions operations API

View a list of room sessions.

SecuritybearerAuth
Request
query Parameters
filter[date_created_at][eq]
string <date>

ISO 8601 date for filtering room sessions created on that date.

Example: filter[date_created_at][eq]=2021-04-25
filter[date_created_at][gte]
string <date>

ISO 8601 date for filtering room sessions created after that date.

Example: filter[date_created_at][gte]=2021-04-25
filter[date_created_at][lte]
string <date>

ISO 8601 date for filtering room sessions created before that date.

Example: filter[date_created_at][lte]=2021-04-25
filter[date_updated_at][eq]
string <date>

ISO 8601 date for filtering room sessions updated on that date.

Example: filter[date_updated_at][eq]=2021-04-25
filter[date_updated_at][gte]
string <date>

ISO 8601 date for filtering room sessions updated after that date.

Example: filter[date_updated_at][gte]=2021-04-25
filter[date_updated_at][lte]
string <date>

ISO 8601 date for filtering room sessions updated before that date.

Example: filter[date_updated_at][lte]=2021-04-25
filter[date_ended_at][eq]
string <date>

ISO 8601 date for filtering room sessions ended on that date.

Example: filter[date_ended_at][eq]=2021-04-25
filter[date_ended_at][gte]
string <date>

ISO 8601 date for filtering room sessions ended after that date.

Example: filter[date_ended_at][gte]=2021-04-25
filter[date_ended_at][lte]
string <date>

ISO 8601 date for filtering room sessions ended before that date.

Example: filter[date_ended_at][lte]=2021-04-25
filter[room_id]
string

Room_id for filtering room sessions.

Example: filter[room_id]=0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
filter[active]
boolean

Filter active or inactive room sessions.

Example: filter[active]=true
include_participants
boolean

To decide if room participants should be included in the response.

Example: include_participants=true
page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

page[number]
integer >= 1
Default: 1

The page number to load

Responses
200

List room sessions response.

Response Schema: application/json
Array of objects (RoomSession)
object (PaginationMeta)
get/room_sessions
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "active": false,
      • "created_at": "2021-04-16T09:46:20.954863Z",
      • "ended_at": "2021-04-16T10:24:55.962200Z",
      • "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
      • "participants": [ ],
      • "record_type": "room_session",
      • "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
      • "updated_at": "2021-04-16T10:24:55.962200Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
View a room session.
SecuritybearerAuth 
Request 
path Parameters
room_session_id
required
string <uuid> 
The unique identifier of a room session.


 
 Example:  0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
query Parameters
include_participants
boolean
To decide if room participants should be included in the response.


 
 Example:  include_participants=true
Responses 
200
Get room session response.


Response Schema: application/json
object (RoomSession) 
 
active
boolean
Shows if the room session is active or not.


 
created_at
string <datetime> 
ISO 8601 timestamp when the room session was created.


 
ended_at
string <datetime> 
ISO 8601 timestamp when the room session has ended.


 
id
string <uuid> 
A unique identifier for the room session.


 
Array of objects (RoomParticipant) 
 
record_type
string
 
room_id
string <uuid> 
Identify the room hosting that room session.


 
updated_at
string <datetime> 
ISO 8601 timestamp when the room session was updated.


 
404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/room_sessions/{room_session_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "active": false,
    • "created_at": "2021-04-16T09:46:20.954863Z",
    • "ended_at": "2021-04-16T10:24:55.962200Z",
    • "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
    • "participants": [ ],
    • "record_type": "room_session",
    • "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
    • "updated_at": "2021-04-16T10:24:55.962200Z"
    }
}
End a room session.
Note: this will also kick all participants currently present in the room


Request 
path Parameters
room_session_id
required
string <uuid> 
The unique identifier of a room session.


 
 Example:  0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
Responses 
200
Success Action Response


Response Schema: application/json
object
 
result
string
 
post/room_sessions/{room_session_id}/actions/end
Request samples 
Response samples 
application/json
{
  • "data": {
    • "result": "ok"
    }
}
Kick participants from a room session.
Request 
path Parameters
room_session_id
required
string <uuid> 
The unique identifier of a room session.


 
 Example:  0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
Request Body schema: application/json
required
Parameters that can be defined during Kick action.


exclude
Array of strings <uuid> 
List of participant id to exclude from the action.


 
string or Array of strings
Either a list of participant id to perform the action on, or the keyword "all" to perform the action on all participant.


 
Responses 
200
Success Action Response


Response Schema: application/json
object
 
result
string
 
post/room_sessions/{room_session_id}/actions/kick
Request samples 
application/json
{
  • "exclude": [
    • "7b61621f-62e0-4aad-ab11-9fd19e272e73"
    ],
  • "participants": "all"
}
Response samples 
application/json
{
  • "data": {
    • "result": "ok"
    }
}
Mute participants in room session.
Request 
path Parameters
room_session_id
required
string <uuid> 
The unique identifier of a room session.


 
 Example:  0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
Request Body schema: application/json
required
Parameters that can be defined during Mute action.


exclude
Array of strings <uuid> 
List of participant id to exclude from the action.


 
string or Array of strings
Either a list of participant id to perform the action on, or the keyword "all" to perform the action on all participant.


 
Responses 
200
Success Action Response


Response Schema: application/json
object
 
result
string
 
post/room_sessions/{room_session_id}/actions/mute
Request samples 
application/json
{
  • "exclude": [
    • "7b61621f-62e0-4aad-ab11-9fd19e272e73"
    ],
  • "participants": "all"
}
Response samples 
application/json
{
  • "data": {
    • "result": "ok"
    }
}
Unmute participants in room session.
Request 
path Parameters
room_session_id
required
string <uuid> 
The unique identifier of a room session.


 
 Example:  0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
Request Body schema: application/json
required
Parameters that can be defined during Unmute action.


exclude
Array of strings <uuid> 
List of participant id to exclude from the action.


 
string or Array of strings
Either a list of participant id to perform the action on, or the keyword "all" to perform the action on all participant.


 
Responses 
200
Success Action Response


Response Schema: application/json
object
 
result
string
 
post/room_sessions/{room_session_id}/actions/unmute
Request samples 
application/json
{
  • "exclude": [
    • "7b61621f-62e0-4aad-ab11-9fd19e272e73"
    ],
  • "participants": "all"
}
Response samples 
application/json
{
  • "data": {
    • "result": "ok"
    }
}
View a list of room participants.
SecuritybearerAuth 
Request 
path Parameters
room_session_id
required
string <uuid> 
The unique identifier of a room session.


 
 Example:  0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
query Parameters
filter[date_joined_at][eq]
string <date> 
ISO 8601 date for filtering room participants that joined on that date.


 
 Example:  filter[date_joined_at][eq]=2021-04-25
filter[date_joined_at][gte]
string <date> 
ISO 8601 date for filtering room participants that joined after that date.


 
 Example:  filter[date_joined_at][gte]=2021-04-25
filter[date_joined_at][lte]
string <date> 
ISO 8601 date for filtering room participants that joined before that date.


 
 Example:  filter[date_joined_at][lte]=2021-04-25
filter[date_updated_at][eq]
string <date> 
ISO 8601 date for filtering room participants updated on that date.


 
 Example:  filter[date_updated_at][eq]=2021-04-25
filter[date_updated_at][gte]
string <date> 
ISO 8601 date for filtering room participants updated after that date.


 
 Example:  filter[date_updated_at][gte]=2021-04-25
filter[date_updated_at][lte]
string <date> 
ISO 8601 date for filtering room participants updated before that date.


 
 Example:  filter[date_updated_at][lte]=2021-04-25
filter[date_left_at][eq]
string <date> 
ISO 8601 date for filtering room participants that left on that date.


 
 Example:  filter[date_left_at][eq]=2021-04-25
filter[date_left_at][gte]
string <date> 
ISO 8601 date for filtering room participants that left after that date.


 
 Example:  filter[date_left_at][gte]=2021-04-25
filter[date_left_at][lte]
string <date> 
ISO 8601 date for filtering room participants that left before that date.


 
 Example:  filter[date_left_at][lte]=2021-04-25
filter[context]
string
Filter room participants based on the context.


 
 Example:  filter[context]=Alice
page[size]
integer  [ 1 .. 250 ] 
 Default:  20
The size of the page


 
page[number]
integer  >= 1 
 Default:  1
The page number to load


 
Responses 
200
List room participants response.


Response Schema: application/json
Array of objects (RoomParticipant) 
 
object (PaginationMeta) 
 
get/room_sessions/{room_session_id}/participants
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "context": "Alice",
      • "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
      • "joined_at": "2021-04-16T09:46:20.954863Z",
      • "left_at": "2021-04-16T10:24:55.962200Z",
      • "record_type": "room_participant",
      • "session_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
      • "updated_at": "2021-04-16T10:24:55.962200Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}