Sign in
InsightsV1Room

Get a list of Programmable Video Rooms.

Get a list of Programmable Video Rooms.

get/v1/Video/Rooms

Query parameters

RoomTypeVideoRoomSummaryEnumRoomType[]

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

CodecVideoRoomSummaryEnumCodec[]

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

RoomNamestring

Room friendly name.

CreatedAfterstring date-time

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

CreatedBeforestring date-time

Only read rooms that started before this ISO 8601 timestamp.

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 6 of the 51 revisions of this API.11518

  • v169096cb67a2512See the full diff
    • ○

      removed the dev_us1 enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the dev_us2 enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the outside enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the stage_au1 enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the stage_br1 enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the stage_de1 enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the stage_ie1 enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the stage_in1 enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the stage_jp1 enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the stage_sg1 enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the stage_us1 enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the stage_us2 enum value from the // response property for the response status

      response-property-enum-value-removed

  • v18c6fae9ab68c12See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • v1cd57d6a65e2d1See the full diff
    • ▲

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

      request-parameter-type-changed

  • v13452354c496b31See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the enum value opus to the property items/ of the query request parameter Codec

      request-parameter-property-enum-value-added

  • v1480364ed97194See the full diff
    • ○

      removed the DELETE enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the HEAD enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PATCH enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PUT enum value from the // response property for the response status

      response-property-enum-value-removed

  • v1fd83d6640ffd1See the full diff
    • ○

      api tag InsightsV1Room added

      api-tag-added