Sign in
VideoV1Participant

get/v1/Rooms/{RoomSid}/Participants

Path parameters

RoomSidstring required

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

Query parameters

Status'connected' | 'disconnected' | 'reconnecting'

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

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.

Identitystring

Read only the Participants with this User identity value.

DateCreatedAfterstring date-time

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

DateCreatedBeforestring date-time

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

PageSizeinteger

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

Pageinteger

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

PageTokenstring

The page token. This is provided by the API.

Response

OK

Changes

Changed in 3 of the 50 revisions of this API.112

  • v1ff792e53847411See the full diff
    • ●

      added the new reconnecting enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value reconnecting to the query request parameter Status

      request-parameter-enum-value-added

  • v11b9f69e2d5d01See the full diff
    • ▲

      for the query request parameter PageSize, the format changed from no format to int64

      request-parameter-type-changed

  • v1987a2e6965981See the full diff
    • ○

      api tag VideoV1Participant added

      api-tag-added