github.com/twilio/twilio-go@v1.20.1/rest/video/v1/docs/RoomsApi.md (about) 1 # RoomsApi 2 3 All URIs are relative to *https://video.twilio.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateRoom**](RoomsApi.md#CreateRoom) | **Post** /v1/Rooms | 8 [**FetchRoom**](RoomsApi.md#FetchRoom) | **Get** /v1/Rooms/{Sid} | 9 [**ListRoom**](RoomsApi.md#ListRoom) | **Get** /v1/Rooms | 10 [**UpdateRoom**](RoomsApi.md#UpdateRoom) | **Post** /v1/Rooms/{Sid} | 11 12 13 14 ## CreateRoom 15 16 > VideoV1Room CreateRoom(ctx, optional) 17 18 19 20 21 22 ### Path Parameters 23 24 This endpoint does not need any path parameter. 25 26 ### Other Parameters 27 28 Other parameters are passed through a pointer to a CreateRoomParams struct 29 30 31 Name | Type | Description 32 ------------- | ------------- | ------------- 33 **EnableTurn** | **bool** | Deprecated, now always considered to be true. 34 **Type** | **string** | 35 **UniqueName** | **string** | An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource, assuming it does not contain any [reserved characters](https://tools.ietf.org/html/rfc3986#section-2.2) that would need to be URL encoded. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`. 36 **StatusCallback** | **string** | The URL we should call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info. 37 **StatusCallbackMethod** | **string** | The HTTP method we should use to call `status_callback`. Can be `POST` or `GET`. 38 **MaxParticipants** | **int** | The maximum number of concurrent Participants allowed in the room. Peer-to-peer rooms can have up to 10 Participants. Small Group rooms can have up to 4 Participants. Group rooms can have up to 50 Participants. 39 **RecordParticipantsOnConnect** | **bool** | Whether to start recording when Participants connect. ***This feature is not available in `peer-to-peer` rooms.*** 40 **VideoCodecs** | [**[]RoomEnumVideoCodec**](RoomEnumVideoCodec.md) | An array of the video codecs that are supported when publishing a track in the room. Can be: `VP8` and `H264`. ***This feature is not available in `peer-to-peer` rooms*** 41 **MediaRegion** | **string** | The region for the media server in Group Rooms. Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#group-rooms-media-servers). ***This feature is not available in `peer-to-peer` rooms.*** 42 **RecordingRules** | [**interface{}**](interface{}.md) | A collection of Recording Rules that describe how to include or exclude matching tracks for recording 43 **AudioOnly** | **bool** | When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed. Group rooms only. 44 **MaxParticipantDuration** | **int** | The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours). 45 **EmptyRoomTimeout** | **int** | Configures how long (in minutes) a room will remain active after last participant leaves. Valid values range from 1 to 60 minutes (no fractions). 46 **UnusedRoomTimeout** | **int** | Configures how long (in minutes) a room will remain active if no one joins. Valid values range from 1 to 60 minutes (no fractions). 47 **LargeRoom** | **bool** | When set to true, indicated that this is the large room. 48 49 ### Return type 50 51 [**VideoV1Room**](VideoV1Room.md) 52 53 ### Authorization 54 55 [accountSid_authToken](../README.md#accountSid_authToken) 56 57 ### HTTP request headers 58 59 - **Content-Type**: application/x-www-form-urlencoded 60 - **Accept**: application/json 61 62 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 63 [[Back to Model list]](../README.md#documentation-for-models) 64 [[Back to README]](../README.md) 65 66 67 ## FetchRoom 68 69 > VideoV1Room FetchRoom(ctx, Sid) 70 71 72 73 74 75 ### Path Parameters 76 77 78 Name | Type | Description 79 ------------- | ------------- | ------------- 80 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 81 **Sid** | **string** | The SID of the Room resource to fetch. 82 83 ### Other Parameters 84 85 Other parameters are passed through a pointer to a FetchRoomParams struct 86 87 88 Name | Type | Description 89 ------------- | ------------- | ------------- 90 91 ### Return type 92 93 [**VideoV1Room**](VideoV1Room.md) 94 95 ### Authorization 96 97 [accountSid_authToken](../README.md#accountSid_authToken) 98 99 ### HTTP request headers 100 101 - **Content-Type**: Not defined 102 - **Accept**: application/json 103 104 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 105 [[Back to Model list]](../README.md#documentation-for-models) 106 [[Back to README]](../README.md) 107 108 109 ## ListRoom 110 111 > []VideoV1Room ListRoom(ctx, optional) 112 113 114 115 116 117 ### Path Parameters 118 119 This endpoint does not need any path parameter. 120 121 ### Other Parameters 122 123 Other parameters are passed through a pointer to a ListRoomParams struct 124 125 126 Name | Type | Description 127 ------------- | ------------- | ------------- 128 **Status** | **string** | Read only the rooms with this status. Can be: `in-progress` (default) or `completed` 129 **UniqueName** | **string** | Read only rooms with the this `unique_name`. 130 **DateCreatedAfter** | **time.Time** | Read only rooms that started on or after this date, given as `YYYY-MM-DD`. 131 **DateCreatedBefore** | **time.Time** | Read only rooms that started before this date, given as `YYYY-MM-DD`. 132 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000. 133 **Limit** | **int** | Max number of records to return. 134 135 ### Return type 136 137 [**[]VideoV1Room**](VideoV1Room.md) 138 139 ### Authorization 140 141 [accountSid_authToken](../README.md#accountSid_authToken) 142 143 ### HTTP request headers 144 145 - **Content-Type**: Not defined 146 - **Accept**: application/json 147 148 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 149 [[Back to Model list]](../README.md#documentation-for-models) 150 [[Back to README]](../README.md) 151 152 153 ## UpdateRoom 154 155 > VideoV1Room UpdateRoom(ctx, Sidoptional) 156 157 158 159 160 161 ### Path Parameters 162 163 164 Name | Type | Description 165 ------------- | ------------- | ------------- 166 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 167 **Sid** | **string** | The SID of the Room resource to update. 168 169 ### Other Parameters 170 171 Other parameters are passed through a pointer to a UpdateRoomParams struct 172 173 174 Name | Type | Description 175 ------------- | ------------- | ------------- 176 **Status** | **string** | 177 178 ### Return type 179 180 [**VideoV1Room**](VideoV1Room.md) 181 182 ### Authorization 183 184 [accountSid_authToken](../README.md#accountSid_authToken) 185 186 ### HTTP request headers 187 188 - **Content-Type**: application/x-www-form-urlencoded 189 - **Accept**: application/json 190 191 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 192 [[Back to Model list]](../README.md#documentation-for-models) 193 [[Back to README]](../README.md) 194