Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add doc for delete recording #555

Merged
merged 2 commits into from
May 10, 2024
Merged

Add doc for delete recording #555

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10bd79e
add doc for delete recording
yaziine May 9, 2024
fbf13cf
Merge branch 'main' into delete-recording-doc
yaziine May 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docusaurus/video/docusaurus/docs/api/recording/recording_calls.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,41 @@ curl "https://video.stream-io-api.com/video/call/${CALL_TYPE}/${CALL_ID}/recordi
</TabItem>
</Tabs>

## Delete call recording

This endpoint allows to delete call recording.
Please note that recordings will be deleted only if they are stored on Stream side (default).

An error will be returned if:
- the recording doesn't exist
- the recording is not stored on Stream S3 bucket

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">

```js
call.deleteRecording(sessionID, filename);
```

</TabItem>
<TabItem value="py" label="Python">

```py
call.delete_recording(sessionID, filename)
```

</TabItem>
<TabItem value="curl" label="cURL">

```bash
curl -X DELETE "https://video.stream-io-api.com/video/call/${CALL_TYPE}/${CALL_ID}/${SESSION_ID}/${FILENAME}?api_key=${API_KEY}" \
-H "Authorization: ${JWT_TOKEN}" \
-H "stream-auth-type: jwt"
```

</TabItem>
</Tabs>

## Events

These events are sent to users connected to the call and your webhook/SQS:
Expand Down
Loading