Query parameters

• Status string

  Read only the rooms with this status. Can be: in-progress (default) or completed

  Values are in-progress, completed, or failed.

• UniqueName string

  Read only rooms with the this unique_name.

• DateCreatedAfter string(date-time)

  Read only rooms that started on or after this date, given as YYYY-MM-DD.

• DateCreatedBefore string(date-time)

  Read only rooms that started before this date, given as YYYY-MM-DD.

• PageSize integer(int64)

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • rooms array[object]
    Hide rooms attributes Show rooms attributes object

    • sid string | null

      The unique string that Twilio created to identify the Room resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RM[0-9a-fA-F]{32}$.

    • status string

      Values are in-progress, completed, or failed.

    • date_created string(date-time) | null

      The date and time in GMT when the resource was created specified in ISO 8601 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in ISO 8601 format.

    • account_sid string | null

      The SID of the Account that created the Room resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • enable_turn boolean | null

      Deprecated, now always considered to be true.

    • unique_name string | null

      An application-defined string that uniquely identifies the resource. It can be used as a room_sid in place of the resource's sid in the URL to address the resource, assuming it does not contain any reserved characters that would need to be URL encoded. This value is unique for in-progress rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is in-progress.

    • status_callback string(uri) | null

      The URL Twilio calls using the status_callback_method to send status information to your application on every room event. See Status Callbacks for more info.

    • status_callback_method string(http-method) | null

      The HTTP method Twilio uses to call status_callback. Can be POST or GET and defaults to POST.

      Values are GET or POST.

    • end_time string(date-time) | null

      The UTC end time of the room in ISO 8601 format.

    • duration integer | null

      The duration of the room in seconds.

    • type string

      Values are go, peer-to-peer, group, or group-small.

    • max_participants integer

      The maximum number of concurrent Participants allowed in the room.

      Default value is 0.

    • max_participant_duration integer

      The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours).

      Default value is 0.

    • max_concurrent_published_tracks integer | null

      The maximum number of published audio, video, and data tracks all participants combined are allowed to publish in the room at the same time. Check Programmable Video Limits for more details. If it is set to 0 it means unconstrained.

    • record_participants_on_connect boolean | null

      Whether to start recording when Participants connect.

    • video_codecs array[string] | null

      An array of the video codecs that are supported when publishing a track in the room. Can be: VP8 and H264.

      Values are VP8 or H264.

    • media_region string | null

      The region for the Room's media server. Can be one of the available Media Regions.

    • audio_only boolean | null

      When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed.

    • empty_room_timeout integer

      Specifies how long (in minutes) a room will remain active after last participant leaves. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed.

      Default value is 0.

    • unused_room_timeout integer

      Specifies how long (in minutes) a room will remain active if no one joins. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed.

      Default value is 0.

    • large_room boolean | null

      Indicates if this is a large room.

    • url string(uri) | null

      The absolute URL of the resource.

    • links object(uri-map) | null

      The URLs of related resources.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)