blob: f0a76c8a85b2933ce3e486c1b2c9dd2e8463e79d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
# Call API
* API v1: 🏁 Removed with API v4: until Nextcloud 21
* API v2: 🏁 Removed with API v4: Nextcloud 21 only
* API v3: 🏁 Removed with API v4: Nextcloud 21 only
* API v4: Base endpoint `/ocs/v2.php/apps/spreed/api/v4`: since Nextcloud 22
## Get list of connected participants
* Method: `GET`
* Endpoint: `/call/{token}`
* Response:
- Status code:
+ `200 OK`
+ `403 Forbidden` When the conversation is read-only
+ `404 Not Found` When the conversation could not be found for the participant
+ `412 Precondition Failed` When the lobby is active and the user is not a moderator
- Data:
Array of participants, each participant has at least:
| 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
* Method: `POST`
* Endpoint: `/call/{token}`
* 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)) |
| `silent` | bool | Disable start call notifications for group/public calls |
* Response:
- Status code:
+ `200 OK`
+ `403 Forbidden` When the conversation is read-only
+ `404 Not Found` When the conversation could not be found for the participant
+ `404 Not Found` When the user did not join the conversation before
+ `412 Precondition Failed` When the lobby is active and the user is not a moderator
## Send call notification
* Required capability: `send-call-notification`
* Method: `POST`
* Endpoint: `/call/{token}/ring/{attendeeId}`
* Data:
| field | type | Description |
|--------------|------|---------------------------|
| `attendeeId` | int | The participant to notify |
* Response:
- Status code:
+ `200 OK`
+ `400 Bad Request` When the target participant is not a user (Guest, group, etc.)
+ `400 Bad Request` When the target participant is already in the call
+ `400 Bad Request` When the room has no call in process
+ `400 Bad Request` When the actor is not in the call
+ `403 Forbidden` When the current user is not a moderator
+ `404 Not Found` When the conversation could not be found for the participant
+ `412 Precondition Failed` When the lobby is active and the user is not a moderator
## Update call flags
* Method: `PUT`
* Endpoint: `/call/{token}`
* 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:
- Status code:
+ `200 OK`
+ `400 Bad Request` When the user is not in the call
+ `400 Bad Request` When the flags do not contain "in call"
+ `403 Forbidden` When the conversation is read-only
+ `404 Not Found` When the conversation could not be found for the participant
+ `404 Not Found` When the user did not join the conversation before
+ `412 Precondition Failed` When the lobby is active and the user is not a moderator
## Leave a call (but staying in the conversation for future calls and chat)
* Method: `DELETE`
* Endpoint: `/call/{token}`
* Response:
- Status code:
+ `200 OK`
+ `403 Forbidden` When the conversation is read-only
+ `404 Not Found` When the conversation could not be found for the participant
+ `404 Not Found` When the user did not join the conversation before
+ `412 Precondition Failed` When the lobby is active and the user is not a moderator
|
