Skip to content

Commit 28d0423

Browse files
author
Tim Mendoza
committed
Update readme to include recordingrules endpoint
1 parent fe37558 commit 28d0423

File tree

1 file changed

+103
-1
lines changed

1 file changed

+103
-1
lines changed

README.md

Lines changed: 103 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The following section documents the application [token server](/src/video-token-
6666

6767
##### Authentication
6868

69-
The application token server requires an [authentication mechanism](#twilio-rtcappsvideodeploy---authentication-auth) to be specified when deploying. The following section documents each support authentication mechanism.
69+
The application token server requires an [authentication mechanism](#twilio-rtcappsvideodeploy---authentication-auth) to be specified when deploying. The following section documents each supported authentication mechanism.
7070

7171
###### Passcode
7272

@@ -189,6 +189,108 @@ POST /token
189189

190190
</table>
191191

192+
##### Recording Rules
193+
194+
Changes the Recording Rules for a given room SID.
195+
196+
```shell
197+
POST /recordingrules
198+
```
199+
200+
###### Parameters
201+
202+
| Name | Type | Description |
203+
| ---------- | -------- | ------------------------------------------------------------------- |
204+
| `passcode` | `string` | **Required**. The application passcode. |
205+
| `room_sid` | `string` | **Required**. The SID of the room to change the recording rules of. |
206+
| `rules` | `array` | **Required**. An array of recording rules to apply to the room. |
207+
208+
###### Success Responses
209+
210+
<table>
211+
<tr>
212+
<td> <b>Status</b> </td> <td> <b>Response</b> </td>
213+
</tr>
214+
<tr>
215+
<td> 200 </td>
216+
<td>
217+
218+
```json
219+
{
220+
"roomSid": "RM00000000000000000000000000000000",
221+
"rules": [
222+
{
223+
"all": true,
224+
"type": "exclude"
225+
}
226+
],
227+
"dateCreated": "2020-11-18T02:58:20.000Z",
228+
"dateUpdated": "2020-11-18T03:21:18.000Z"
229+
}
230+
```
231+
232+
</td>
233+
</tr>
234+
235+
</table>
236+
237+
###### Error Responses
238+
239+
<table>
240+
<tr>
241+
<td> <b>Status</b> </td> <td> <b>Response</b> </td>
242+
</tr>
243+
244+
<tr>
245+
<td> 400 </td>
246+
<td>
247+
248+
```json
249+
{
250+
"error": {
251+
"message": "missing room_sid",
252+
"explanation": "The room_sid parameter is missing."
253+
}
254+
}
255+
```
256+
257+
</td>
258+
</tr>
259+
260+
<tr>
261+
<td> 400 </td>
262+
<td>
263+
264+
```json
265+
{
266+
"error": {
267+
"message": "missing rules",
268+
"explanation": "The rules parameter is missing."
269+
}
270+
}
271+
```
272+
273+
</td>
274+
</tr>
275+
276+
<tr>
277+
<td> 401 </td>
278+
<td>
279+
280+
```json
281+
{
282+
"error": {
283+
"message": "passcode incorrect",
284+
"explanation": "The passcode used to validate application users is incorrect."
285+
}
286+
}
287+
```
288+
289+
</td>
290+
</tr>
291+
292+
</table>
293+
192294
## Commands
193295

194296
<!-- commands -->

0 commit comments

Comments
 (0)