Skip to content

Commit

Permalink
add gdpr section + delete call doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yaziine committed Jun 10, 2024
1 parent 51881e0 commit 87cd8ec
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docusaurus/video/docusaurus/docs/api/gdpr/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "GDPR",
"position": 7
}
60 changes: 60 additions & 0 deletions docusaurus/video/docusaurus/docs/api/gdpr/calls.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
id: calls
sidebar_position: 1
slug: /gdpr/calls
title: Calls
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


## Deleting a call

You can either soft-delete or hard-delete a call and all its related data (members, sessions, recordings, transcriptions).

When hard-deleting a call, it is marked as deleted synchronously and then will be completely wiped from our system and its related data asynchronously.
An ID is returned which allows you to follow the status of the async task.

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

```js
// soft-delete a call
const resp = await call.delete({
hard: false,
});
// resp.call contains call information

// hard-delete a call
const resp = await call.delete({
hard: true,
});
// resp.taskID is the ID to be used for following task status
```

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

```bash
# Soft-delete a call
curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}/delete?api_key=${API_KEY}" \
-H "Authorization: ${TOKEN}" \
-H "stream-auth-type: jwt" \
-H "Content-Type: application/json" \
-d '{
"hard": false
}'

# Unpin video
curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}/delete?api_key=${API_KEY}" \
-H "Authorization: ${TOKEN}" \
-H "stream-auth-type: jwt" \
-H "Content-Type: application/json" \
-d '{
"hard": true
}'
```

</TabItem>
</Tabs>

0 comments on commit 87cd8ec

Please sign in to comment.