# List Room Sessions

GET https://%7Byour_space_name%7D.signalwire.com/api/video/room_sessions

A list of past and in-progress Room Sessions.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Video_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/video/room-sessions/list-room-sessions

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: video
  version: 1.0.0
paths:
  /room_sessions:
    get:
      operationId: list-room-sessions
      summary: List Room Sessions
      description: >-
        A list of past and in-progress Room Sessions.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Video_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_roomSessions
      parameters:
        - name: room_id
          in: query
          description: Return Sessions started from this Room.
          required: false
          schema:
            type: string
            format: uuid
        - name: room_name
          in: query
          description: Return Sessions with a matching room name.
          required: false
          schema:
            type: string
        - name: room_name_matches
          in: query
          description: >-
            Return Sessions with a room name matching this pattern (substring
            match).
          required: false
          schema:
            type: string
        - name: status
          in: query
          description: Return Sessions currently in this state.
          required: false
          schema:
            $ref: '#/components/schemas/RoomSessionStatus'
        - name: page_number
          in: query
          description: >-
            Page number to return. Requires `page_token` for values greater than
            0.
          required: false
          schema:
            type: integer
            default: 0
        - name: page_size
          in: query
          description: >-
            Specify the number of results to return on a single page. The
            default page size is `50` and the maximum is `1000`.
          required: false
          schema:
            type: integer
            default: 50
        - name: page_token
          in: query
          description: >-
            Token for cursor-based pagination. Required when `page_number` is
            greater than 0.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            SignalWire Basic Authentication using Project ID and API Token.


            The client sends HTTP requests with the Authorization header
            containing

            the word Basic followed by a space and a base64-encoded string of
            project_id:token.

            The project ID will be used as the username and the API token as the
            password.


            Example:

            ```

            Authorization: Basic base64(project_id:token)

            ```
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRoomSessionsResponse'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode400'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://%7Byour_space_name%7D.signalwire.com/api/video
components:
  schemas:
    RoomSessionStatus:
      type: string
      enum:
        - in-progress
        - completed
      description: Status of a room session.
      title: RoomSessionStatus
    PaginationLinks:
      type: object
      properties:
        self:
          type: string
          description: Link to the current page.
        first:
          type: string
          description: Link to the first page.
        next:
          type: string
          description: Link to the next page.
        prev:
          type: string
          description: Link to the previous page.
      required:
        - self
        - first
      description: Pagination links for list responses.
      title: PaginationLinks
    VideoQuality:
      type: string
      enum:
        - 720p
        - 1080p
      description: Video quality resolution.
      title: VideoQuality
    VideoFps:
      type: string
      enum:
        - '20'
        - '30'
      description: Video frames per second.
      title: VideoFps
    RoomSession:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID of the session.
        room_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            Unique ID of the Room if the Session was created from a Room and was
            not an auto-created Session. Null if the room was set to delete on
            end.
        name:
          type:
            - string
            - 'null'
          description: The named identifier of the room session.
        display_name:
          type:
            - string
            - 'null'
          description: >-
            Display name of the room. Maximum of 200 characters. Defaults to the
            value of name.
        max_members:
          type:
            - integer
            - 'null'
          description: The maximum number of members allowed in the room at a time.
        quality:
          oneOf:
            - $ref: '#/components/schemas/VideoQuality'
            - type: 'null'
          description: The room session's resolution.
        fps:
          oneOf:
            - $ref: '#/components/schemas/VideoFps'
            - type: 'null'
          description: The room session's frames per second.
        join_from:
          type:
            - string
            - 'null'
          format: date-time
          description: Room Session does not accept new Members before this time.
        join_until:
          type:
            - string
            - 'null'
          format: date-time
          description: Room Session stops accepting new Members at this time.
        remove_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Remove Members from the Room Session at this time.
        remove_after_seconds_elapsed:
          type:
            - integer
            - 'null'
          description: Remove Members after they are in the Room Session for N seconds.
        layout:
          type:
            - string
            - 'null'
          description: The room session's initial layout.
        record_on_start:
          type: boolean
          description: >-
            Whether a recording was automatically started when this Room Session
            began.
        tone_on_entry_and_exit:
          type: boolean
          description: >-
            Whether a tone is played when a member enters or exits the room
            session.
        room_join_video_off:
          type: boolean
          description: Whether participants join with video off by room setting.
        user_join_video_off:
          type: boolean
          description: Whether participants join with video off by user setting.
        locked:
          type: boolean
          description: Whether the room session is locked.
        start_time:
          type:
            - string
            - 'null'
          format: date-time
          description: Start time of the session.
        end_time:
          type:
            - string
            - 'null'
          format: date-time
          description: End time of the session.
        duration:
          type:
            - integer
            - 'null'
          description: How long, in seconds, the Room Session lasted.
        status:
          oneOf:
            - $ref: '#/components/schemas/RoomSessionStatus'
            - type: 'null'
          description: Status of the session.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the room session was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the room session was last updated.
        preview_url:
          type:
            - string
            - 'null'
          description: >-
            If room previews are enabled and the room session is in progress,
            this is the URL of the preview video.
        prioritize_handraise:
          type:
            - boolean
            - 'null'
          description: Whether raised hands are prioritized in the layout.
        sync_audio_video:
          type:
            - boolean
            - 'null'
          description: Enable/disable jitter buffer audio-video sync.
        cost_in_dollars:
          type: number
          format: double
          description: The cost of the room session in dollars.
        enable_room_previews:
          type: boolean
          description: >-
            Whether a video with a preview of the content of the room is to be
            generated.
        locked_cover:
          type: string
          description: URL of the locked room cover image.
      required:
        - id
        - room_id
        - name
        - display_name
        - max_members
        - quality
        - fps
        - join_from
        - join_until
        - remove_at
        - remove_after_seconds_elapsed
        - layout
        - record_on_start
        - tone_on_entry_and_exit
        - room_join_video_off
        - user_join_video_off
        - locked
        - start_time
        - end_time
        - duration
        - status
        - created_at
        - updated_at
        - preview_url
        - prioritize_handraise
        - sync_audio_video
        - cost_in_dollars
        - enable_room_previews
        - locked_cover
      description: Room session response object.
      title: RoomSession
    ListRoomSessionsResponse:
      type: object
      properties:
        links:
          $ref: '#/components/schemas/PaginationLinks'
          description: Pagination links.
        data:
          type: array
          items:
            $ref: '#/components/schemas/RoomSession'
          description: List of room sessions.
      required:
        - links
        - data
      description: List room sessions response.
      title: ListRoomSessionsResponse
    TypesStatusCodesStatusCode400Error:
      type: string
      enum:
        - Bad Request
      title: TypesStatusCodesStatusCode400Error
    Types.StatusCodes.StatusCode400:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode400Error'
      required:
        - error
      description: The request is invalid.
      title: Types.StatusCodes.StatusCode400
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    Types.StatusCodes.RestApiErrorItem:
      type: object
      properties:
        type:
          type: string
          description: The category of error.
        code:
          type: string
          description: A specific error code.
        message:
          type: string
          description: A description of what caused the error.
        attribute:
          type:
            - string
            - 'null'
          description: The request parameter that caused the error, if applicable.
        url:
          type: string
          description: A link to documentation about this error.
      required:
        - type
        - code
        - message
        - url
      description: Details about a specific error.
      title: Types.StatusCodes.RestApiErrorItem
    VideoStatusCode422:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request contains invalid parameters. See errors for details.
      title: VideoStatusCode422
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of
        project_id:token.

        The project ID will be used as the username and the API token as the
        password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://{your_space_name}.signalwire.com/api/video/room_sessions"

headers = {"Authorization": "Basic <project_id>:<api_token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/video/room_sessions';
const options = {method: 'GET', headers: {Authorization: 'Basic <project_id>:<api_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{your_space_name}.signalwire.com/api/video/room_sessions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://{your_space_name}.signalwire.com/api/video/room_sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://{your_space_name}.signalwire.com/api/video/room_sessions")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://{your_space_name}.signalwire.com/api/video/room_sessions', [
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/video/room_sessions");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Basic <project_id>:<api_token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/video/room_sessions")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```