100ms Logo

100ms

Docs

Search docs
/

Session object

Overview

Session is a single continuous call in a room. To allow users to join a 100ms video conferencing session inside your app, you first need to create a room. A single room can have multiple sessions. You will need a management token as a bearer token for your requests.

This API retrieves details of a list of sessions in your account. 100ms provides actions to

  1. retrieve a specific session
  2. retrieve a list of sessions based on filters like:
    • status(active/inactive)
    • room_id
    • started time-range

Note: The maximum allowed duration for a session on the 100ms platform is 12 hours.

Endpointhttps://api.100ms.live/v2/sessions

Session object

ArgumentDescription
idUnique identifier for the session.
room_idUnique identifier for the room used for the particular session.
customer_idUnique identifier for your account
activeIndicates whether the session is active or inactive
peersArray of peer objects with arguments such as id, session_id, name, role, user, joined_at, left_at, etc.

Peer object

ArgumentDescription
idUnique identifier for the peer.
session_idUnique identifier for the session.
nameAlias/name of the peer used to join the session.
roleIndicates the name of the role. Example: Host, Guest, Backstage, etc.
userUnique identifier for the peer generated by 100ms
joined_atTimestamp when the peer joined the session.
left_atTimestamp when the peer left the session.

Postman collection

You can use our Postman collection to start exploring 100ms APIs.

Run in Postman

Refer to the Postman guide to get started with 100ms API collection.



Run in postman