Path parameters

• RoomSid string Required

  The SID of the room with the Participant resources to read.

Query parameters

• Status string

  Read only the participants with this status. Can be: connected or disconnected. For in-progress Rooms the default Status is connected, for completed Rooms only disconnected Participants are returned.

  Values are connected, disconnected, or reconnecting.

• Identity string

  Read only the Participants with this User identity value.

• DateCreatedAfter string(date-time)

  Read only Participants that started after this date in ISO 8601 format.

• DateCreatedBefore string(date-time)

  Read only Participants that started before this date in ISO 8601 format.

• 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

    • sid string | null

      The unique string that we created to identify the RoomParticipant resource.

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

    • room_sid string | null

      The SID of the participant's room.

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

    • account_sid string | null

      The SID of the Account that created the RoomParticipant resource.

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

    • status string

      The status of the Participant. Can be: connected or disconnected.

      Values are connected, disconnected, or reconnecting.

    • identity string | null

      The application-defined string that uniquely identifies the resource's User within a Room. If a client joins with an existing Identity, the existing client is disconnected. See access tokens and limits for more info.

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

    • start_time string(date-time) | null

      The time of participant connected to the room in ISO 8601 format.

    • end_time string(date-time) | null

      The time when the participant disconnected from the room in ISO 8601 format.

    • duration integer | null

      The duration in seconds that the participant was connected. Populated only after the participant is disconnected.

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