diff options
| author | Vitor Mattos <vitor@php.rio> | 2023-01-03 12:33:36 -0300 |
|---|---|---|
| committer | Vitor Mattos <vitor@php.rio> | 2023-01-03 12:33:36 -0300 |
| commit | 555b74c733e2e67ada66407013361d521e207d37 (patch) | |
| tree | b215816a758eafb2136b1dabe55fc92dfd0c2c03 /docs | |
| parent | 5484a27cf2b81a6e3797a5b9365f270f15ac0b33 (diff) | |
Changes after code review
Signed-off-by: Vitor Mattos <vitor@php.rio>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/recording.md | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/docs/recording.md b/docs/recording.md index 2b8512b9c..463e0f2c6 100644 --- a/docs/recording.md +++ b/docs/recording.md @@ -53,21 +53,22 @@ * Data: -| field | type | Description | -| ------- | ------ | ----------------------------------------------- | -| `file` | string | Blob of image in a multipart/form-data request. | -| `owner` | string | The moderator/owner of room. | +| field | type | Description | +| ------- | ------ | --------------------------------------------------------- | +| `file` | string | File with the recording in a multipart/form-data request. | +| `owner` | string | The person that started the recording. | * Response: - Status code: + `200 OK` - + `400 Bad Request` Message: `invalid_file`. File in block list or invalid. - + `400 Bad Request` Message: `empty_file`. Invalid file extension. - + `400 Bad Request` Message: `file_mimetype`. Invalid mimetype. - + `400 Bad Request` Message: `file_name`. Invalid file name. - + `400 Bad Request` Message: `file_extension`. Invalid file extension. - + `400 Bad Request` Message: `owner_participant`. Onwer need to be a participant of room. - + `400 Bad Request` Message: `owner_invalid`. Onwer invalid. - + `400 Bad Request` Message: `owner_permission`. Onwer have not permission to store record file. + + `400 Bad Request` Error: `invalid_file`: File in block list or invalid + + `400 Bad Request` Error: `empty_file`: Invalid file extension + + `400 Bad Request` Error: `file_mimetype`: Invalid mimetype + + `400 Bad Request` Error: `file_name`. :nvalid file name + + `400 Bad Request` Error: `file_extension`: Invalid file extension + + `400 Bad Request` Error: `owner_participant`: Owner is not to be a participant of room + + `400 Bad Request` Error: `owner_invalid`: Owner invalid + + `400 Bad Request` Error: `owner_permission`: Owner have not permission to store record file + `401 Unauthorized` When the validation as SIP bridge failed - + `404 Not Found` Invalid room or brute force identified. + + `404 Not Found` Room not found + + `429 Too Many Request` Brute force protection |