summaryrefslogtreecommitdiffstats
path: root/docs/call.md
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2021-05-07 14:33:38 +0200
committerJoas Schilling <coding@schilljs.com>2021-05-07 14:33:38 +0200
commitbed14653db881dd7d917e02f96f869fd25d19f26 (patch)
treee8e388d9de1793d8e7f0ce5de497f703348b2bf3 /docs/call.md
parent4733fe150f800f1c23f8818c2ff0cd38de34f4e3 (diff)
Add versions to API docs (sorry for cleaning up)
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs/call.md')
-rw-r--r--docs/call.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/call.md b/docs/call.md
index 827b733fa..fb44d17cc 100644
--- a/docs/call.md
+++ b/docs/call.md
@@ -20,13 +20,14 @@
- Data:
Array of participants, each participant has at least:
- field | type | API | Description
- ------|------|-----|------------
- `actorType` | string | v4 | Actor type of the attendee (see [Constants - Attendee types](constants.md#attendee-types))
- `actorId` | string | v4 | The user id, guest random id or email address of the attendee
- `displayName` | string | v4 | The display name of the attendee
- `lastPing` | int | v4 | Timestamp of the last ping of the user (should be used for sorting)
- `sessionId` | string | v4 | 512 character long string
+ field | type | Added | Removed | Description
+ ---|---|---|---|---
+ `actorType` | string | v3 | | Actor type of the attendee (see [Constants - Attendee types](constants.md#attendee-types))
+ `actorId` | string | v3 | | The user id, guest random id or email address of the attendee
+ `userId` | string | v1 | v3 | The user id replaced with actorType = users and actorId being the userId
+ `displayName` | string | v3 | | The display name of the attendee
+ `lastPing` | int | v1 | | Timestamp of the last ping of the user (should be used for sorting)
+ `sessionId` | string | v1 | | 512 character long string
## Join a call
@@ -35,7 +36,7 @@
* Data:
field | type | Description
- ------|------|------------
+ ---|---|---
`flags` | int | Flags what streams are provided by the participant (see [Constants - Participant in-call flag](constants.md#participant-in-call-flag))
* Response: