diff options
| author | Vitor Mattos <vitor@php.rio> | 2022-12-12 14:26:59 -0300 |
|---|---|---|
| committer | Vitor Mattos <vitor@php.rio> | 2022-12-12 14:26:59 -0300 |
| commit | b06786de2583d81a4abe5177ff4a44a27fdce155 (patch) | |
| tree | b596960fac12e3f28b9ec82f6a3d7540db687b79 /docs | |
| parent | 0f179b79d5817cc93b1f8e3653c5010cc7f5ea46 (diff) | |
Moved methods of recording api to specific controller
Signed-off-by: Vitor Mattos <vitor@php.rio>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.md | 1 | ||||
| -rw-r--r-- | docs/recording.md | 33 |
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md index 3e1dec1dc..98858fa0c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,6 +15,7 @@ * [Conversation API](conversation.md) * [Participant API](participant.md) * [Call API](call.md) +* [Call recordingn API](call.md) * [Chat API](chat.md) * [Reaction API](reaction.md) * [Webinar API](webinar.md) diff --git a/docs/recording.md b/docs/recording.md new file mode 100644 index 000000000..b3afa04c3 --- /dev/null +++ b/docs/recording.md @@ -0,0 +1,33 @@ +# 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` When the status to start is invalid + + `400 Bad Request` The haven't the capability `recording-v1` + + `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` The haven't the capability `recording-v1` + + `412 Precondition Failed` When the lobby is active and the user is not a moderator |