Get a list of room participants

GET /v1/Video/Rooms/{RoomSid}/Participants

TODO: Resource-level docs

Get a list of room participants.

Path parameters

  • RoomSid string Required

    The SID of the Room resource.

Query parameters

  • PageSize integer

    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.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes
    • participants array[object]
      Hide participants attributes Show participants attributes
      • 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}$.

      • codecs array[string] | null

        Codecs detected from the participant.

        Values are VP8, H264, or VP9.

      • duration_sec integer | null

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

      • edge_location string | null

        Name of the edge location the participant connected to.

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

      • end_reason string | null

        Reason the participant left the room.

      • error_code integer | null

        Errors encountered by the participant.

      • error_code_url string | null

        Twilio error code dictionary link.

      • join_time string(date-time) | null

        When the participant joined the room.

      • leave_time string(date-time) | null

        When the participant left the room

      • media_region string | null

        Twilio media region the participant connected to.

        Values are us1, us2, au1, br1, ie1, jp1, sg1, in1, de1, or gll.

      • participant_identity string | null

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

      • 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}$.

      • properties

        Object containing information about the participant's data from the room.

      • publisher_info

        Object containing information about the SDK name and version.

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

        Values are in_progress or completed.

      • url string(uri) | null

        URL of the participant resource.
GET /v1/Video/Rooms/{RoomSid}/Participants 
curl \
 -X GET https://insights.twilio.com/v1/Video/Rooms/{RoomSid}/Participants \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "participants": [
    {
      "account_sid": "string",
      "codecs": [
        "VP8"
      ],
      "duration_sec": 42,
      "edge_location": "ashburn",
      "end_reason": "string",
      "error_code": 42,
      "error_code_url": "string",
      "join_time": "2023-05-04T09:42:00+00:00",
      "leave_time": "2023-05-04T09:42:00+00:00",
      "media_region": "us1",
      "participant_identity": "string",
      "participant_sid": "string",
      "room_sid": "string",
      "status": "in_progress",
      "url": "https://example.com"
    }
  ]
}