From 7bee38ff2469efcc34d8e8ada8108df88a2ba212 Mon Sep 17 00:00:00 2001 From: Vitor Mattos Date: Wed, 18 Jan 2023 19:08:58 -0300 Subject: Update documentation Signed-off-by: Vitor Mattos --- docs/recording.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/recording.md b/docs/recording.md index 695dbbb62..b077e973b 100644 --- a/docs/recording.md +++ b/docs/recording.md @@ -80,12 +80,33 @@ * Endpoint: `/recording/{token}/notification` * Data: -| field | type | Description | -| ---------- | ------ | --------------------------------------------------------- | -| `dateTime` | string | The date time that notification was created. | +| field | type | Description | +| ----------- | ------ | --------------------------------------------------------------------- | +| `timestamp` | string | Timestamp in seconds and UTC time zone that notification was created. | * Response: - Status code: + `200 OK` + `403 Forbidden` When the user is not a moderator/owner. + `404 Not Found` Room not found + +## Share store call recording + +* Required capability: `recording-v1` +* Method: `POST` +* Endpoint: `/recording/{token}/share-chat` +* Data: + +| field | type | Description | +| ----------- | ------- | --------------------------------------------------------------------- | +| `timestamp` | string | Timestamp in seconds and UTC time zone that notification was created. | +| `fileId` | integer | File id of recording to share at the room. | + +* Response: + - Status code: + + `200 OK` + + `400 Bad Request` Error: `file`: Shared file is invalid + + `400 Bad Request` Error: `file-long-data`: Shared file have a too big name that can't stay in a message + + `400 Bad Request` Error: `send-system-message`: Failed to send the shared file as system message + + `403 Forbidden` When the user is not a moderator/owne + + `404 Not Found` Room not found -- cgit v1.2.3