Query parameters

• RoomType array[string | null]

  Type of room. Can be go, peer_to_peer, group, or group_small.

  Values are go, peer_to_peer, group, or group_small.

• Codec array[string]

  Codecs used by participants in the room. Can be VP8, H264, or VP9.

  Values are VP8, H264, VP9, or opus.

• RoomName string

  Room friendly name.

• CreatedAfter string(date-time)

  Only read rooms that started on or after this ISO 8601 timestamp.

• CreatedBefore string(date-time)

  Only read rooms that started before this ISO 8601 timestamp.

• 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

    • account_sid string | null

      Account SID associated with this room.

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

    • room_sid string | null

      Unique identifier for the room.

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

    • room_name string | null

      Room friendly name.

    • create_time string(date-time) | null

      Creation time of the room.

    • end_time string(date-time) | null

      End time for the room.

    • room_type string | null

      Type of room. Can be go, peer_to_peer, group, or group_small.

      Values are go, peer_to_peer, group, or group_small.

    • room_status string | null

      Status of the room. Can be in_progress or completed.

      Values are in_progress or completed.

    • status_callback string(uri) | null

      Webhook provided for status callbacks.

    • status_callback_method string(http-method) | null

      HTTP method provided for status callback URL.

      Values are GET or POST.

    • created_method string | null

      How the room was created. Can be sdk, ad_hoc, or api.

      Values are sdk, ad_hoc, or api.

    • end_reason string | null

      Reason the room ended. Can be room_ended_via_api or timeout.

      Values are room_ended_via_api or timeout.

    • max_participants integer | null

      Max number of total participants allowed by the application settings.

    • unique_participants integer | null

      Number of participants. May include duplicate identities for participants who left and rejoined.

    • unique_participant_identities integer | null

      Unique number of participant identities.

    • concurrent_participants integer | null

      Actual number of concurrent participants.

    • max_concurrent_participants integer | null

      Maximum number of participants allowed in the room at the same time allowed by the application settings.

    • codecs array[string] | null

      Codecs used by participants in the room. Can be VP8, H264, or VP9.

      Values are VP8, H264, VP9, or opus.

    • media_region string | null

      Region of Twilio media servers for the room. See the list of possible media servers here.

      Values are us1, us2, au1, br1, ie1, jp1, sg1, in1, de1, gll, stage_us1, stage_us2, dev_us1, dev_us2, stage_de1, stage_in1, stage_ie1, stage_br1, stage_au1, stage_sg1, stage_jp1, or outside.

    • duration_sec integer(int64) | null

      Total room duration from create time to end time.

    • total_participant_duration_sec integer(int64) | null

      Combined amount of participant time in the room.

    • total_recording_duration_sec integer(int64) | null

      Combined amount of recorded seconds for participants in the room.

    • processing_state string | null

      Video Log Analyzer resource state. Will be either in-progress or complete. in-progress indicates that more details may be appended to the resource. complete indicates no further information will be added.

      Values are complete, in_progress, timeout, or not_started.

    • recording_enabled boolean | null

      Boolean indicating if recording is enabled for the room.

    • edge_location string | null

      Edge location of Twilio media servers for the room. See the list of public edge locations for the possible values.

      Values are ashburn, dublin, frankfurt, singapore, sydney, sao_paulo, roaming, umatilla, or tokyo.

    • url string(uri) | null

      URL for the room resource.

    • links object(uri-map) | null

      Room subresources.

  • 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)