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
- retrieve a specific session
- 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.
Do check the Build attendance example to see how you can use this API to get the attendance data of a particular session.
Endpointhttps://api.100ms.live/v2/sessions
Session object
| Argument | Description |
|---|---|
| id | Unique identifier for the session. |
| room_id | Unique identifier for the room used for the particular session. |
| customer_id | Unique identifier for your account |
| active | Indicates whether the session is active or inactive |
| peers | Array of peer objects with arguments such as id, session_id, name, role, user, joined_at, left_at, etc. |
Peer object
| Argument | Description |
|---|---|
| id | Unique identifier for the peer. |
| session_id | Unique identifier for the session. |
| name | Alias/name of the peer used to join the session. |
| role | Indicates the name of the role. Example: Host, Guest, Backstage, etc. |
| user_id | Internal user identifier or random string specified for peer during Auth token generation. |
| user (Deprecated) | Unique identifier for the peer generated by 100ms |
| joined_at | Timestamp when the peer joined the session. |
| left_at | Timestamp when the peer left the session. |
Postman collection
You can use our Postman collection to start exploring 100ms APIs.
Refer to the Postman guide to get started with 100ms API collection.
Have a suggestion? Recommend changes ->
