Path parameters

• RoomSid string Required

  The SID of the Room resource.

Query parameters

• 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

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

    • participant_sid string | null

      Unique identifier for the participant.

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

    • participant_identity string | null

      The application-defined string that uniquely identifies the participant within a Room.

    • join_time string(date-time) | null

      When the participant joined the room.

    • leave_time string(date-time) | null

      When the participant left the room.

    • duration_sec integer(int64) | null

      Amount of time in seconds the participant was in the room.

    • account_sid string | null

      Account SID associated with the 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}$.

    • status string | null

      Status of the room. Can be in_progress or completed.

      Values are in_progress, connected, completed, or disconnected.

    • codecs array[string] | null

      Codecs detected from the participant. Can be VP8, H264, or VP9.

      Values are VP8, H264, VP9, or opus.

    • end_reason string | null

      Reason the participant left the room. See the list of possible values here.

    • error_code integer | null

      Errors encountered by the participant.

    • error_code_url string | null

      Twilio error code dictionary link.

    • media_region string | null

      Twilio media region the participant connected to. See the list of possible media servers here.

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

    • properties object | null

      Object containing information about the participant's data from the room. See below for more information.

    • edge_location string | null

      Name of the edge location the participant connected to. See the list of public edge locations for the possible values.

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

    • publisher_info object | null

      Object containing information about the SDK name and version. See below for more information.

    • url string(uri) | null

      URL of the participant resource.

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