summaryrefslogtreecommitdiffstats
path: root/docs/recording.md
blob: efbf437a155755f7244c6124623fdabe95a0dfcf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# Call recording API

* API v1: 🏁 since Nextcloud 26

## Start call recording

* Required capability: `recording-v1`
* Method: `POST`
* Endpoint: `/recording/{token}`
* Data:

| Field  | Type | Description                                           |
| ------ | ---- | ----------------------------------------------------- |
| status | int  | Type of call recording when 1 is video and 2 is audio |

* Response:
    - Status code:
        + `200 OK`
        + `400 Bad Request` Message: `status`. When the status to start is invalid.
        + `400 Bad Request` Message: `config`. Need to enable the config `recording`.
        + `400 Bad Request` Message: `room`. Already have a recording in progress.
        + `412 Precondition Failed` When the lobby is active and the user is not a moderator.

## Stop call recording

* Required capability: `recording-v1`
* Method: `DELETE`
* Endpoint: `/recording/{token}`

* Response:
    - Status code:
        + `200 OK`
        + `400 Bad Request` Message: `config`. Need to enable the config `recording`.
        + `400 Bad Request` Message: `room`. Recording has already been stopped.
        + `412 Precondition Failed` When the lobby is active and the user is not a moderator.