Skip to content

Commit

Permalink
Add doc for delete recording (#555)
Browse files Browse the repository at this point in the history
  • Loading branch information
yaziine authored May 10, 2024
2 parents af2e636 + fbf13cf commit 3622409
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docusaurus/video/docusaurus/docs/api/recording/recording_calls.mdx
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

0 comments on commit 3622409

Please sign in to comment.