github.com/twilio/twilio-go@v1.20.1/rest/insights/v1/docs/VideoRoomsApi.md (about)

     1  # VideoRoomsApi
     2  
     3  All URIs are relative to *https://insights.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchVideoRoomSummary**](VideoRoomsApi.md#FetchVideoRoomSummary) | **Get** /v1/Video/Rooms/{RoomSid} | 
     8  [**ListVideoRoomSummary**](VideoRoomsApi.md#ListVideoRoomSummary) | **Get** /v1/Video/Rooms | 
     9  
    10  
    11  
    12  ## FetchVideoRoomSummary
    13  
    14  > InsightsV1VideoRoomSummary FetchVideoRoomSummary(ctx, RoomSid)
    15  
    16  
    17  
    18  Get Video Log Analyzer data for a Room.
    19  
    20  ### Path Parameters
    21  
    22  
    23  Name | Type | Description
    24  ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **RoomSid** | **string** | The SID of the Room resource.
    27  
    28  ### Other Parameters
    29  
    30  Other parameters are passed through a pointer to a FetchVideoRoomSummaryParams struct
    31  
    32  
    33  Name | Type | Description
    34  ------------- | ------------- | -------------
    35  
    36  ### Return type
    37  
    38  [**InsightsV1VideoRoomSummary**](InsightsV1VideoRoomSummary.md)
    39  
    40  ### Authorization
    41  
    42  [accountSid_authToken](../README.md#accountSid_authToken)
    43  
    44  ### HTTP request headers
    45  
    46  - **Content-Type**: Not defined
    47  - **Accept**: application/json
    48  
    49  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    50  [[Back to Model list]](../README.md#documentation-for-models)
    51  [[Back to README]](../README.md)
    52  
    53  
    54  ## ListVideoRoomSummary
    55  
    56  > []InsightsV1VideoRoomSummary ListVideoRoomSummary(ctx, optional)
    57  
    58  
    59  
    60  Get a list of Programmable Video Rooms.
    61  
    62  ### Path Parameters
    63  
    64  This endpoint does not need any path parameter.
    65  
    66  ### Other Parameters
    67  
    68  Other parameters are passed through a pointer to a ListVideoRoomSummaryParams struct
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **RoomType** | [**[]VideoRoomSummaryEnumRoomType**](VideoRoomSummaryEnumRoomType.md) | Type of room. Can be `go`, `peer_to_peer`, `group`, or `group_small`.
    74  **Codec** | [**[]VideoRoomSummaryEnumCodec**](VideoRoomSummaryEnumCodec.md) | Codecs used by participants in the room. Can be `VP8`, `H264`, or `VP9`.
    75  **RoomName** | **string** | Room friendly name.
    76  **CreatedAfter** | **time.Time** | Only read rooms that started on or after this ISO 8601 timestamp.
    77  **CreatedBefore** | **time.Time** | Only read rooms that started before this ISO 8601 timestamp.
    78  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    79  **Limit** | **int** | Max number of records to return.
    80  
    81  ### Return type
    82  
    83  [**[]InsightsV1VideoRoomSummary**](InsightsV1VideoRoomSummary.md)
    84  
    85  ### Authorization
    86  
    87  [accountSid_authToken](../README.md#accountSid_authToken)
    88  
    89  ### HTTP request headers
    90  
    91  - **Content-Type**: Not defined
    92  - **Accept**: application/json
    93  
    94  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    95  [[Back to Model list]](../README.md#documentation-for-models)
    96  [[Back to README]](../README.md)
    97