blob: 3d34f8b7fcb84ab91984bcb7504b6e3b5418920e (
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
# Participant API
Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
## Get list of participants in a conversation
* Method: `GET`
* Endpoint: `/room/{token}/participants`
* Response:
- Header:
+ `200 OK`
+ `404 Not Found` When the conversation could not be found for the participant
- Data:
Array of participants, each participant has at least:
field | type | Description
------|------|------------
`userId` | string | Is empty for guests
`displayName` | string | Can be empty for guests
`participantType` | int | Permissions level of the participant
`lastPing` | int | Timestamp of the last ping of the user (should be used for sorting)
`sessionId` | string | `'0'` if not connected, otherwise a 512 character long string
## Add a participant to a conversation
* Method: `POST`
* Endpoint: `/room/{token}/participants`
* Data:
field | type | Description
------|------|------------
`newParticipant` | string | User, group or email to add
`source` | string | Source of the participant(s) as returned by the autocomplete suggestion endpoint (default is `users`)
* Response:
- Header:
+ `200 OK`
+ `403 Forbidden` When the current user is not a moderator/owner
+ `400 Bad Request` When the source type is unknown
+ `404 Not Found` When the conversation could not be found for the participant
+ `404 Not Found` When the user or group to add could not be found
- Data:
field | type | Description
------|------|------------
`type` | int | In case the conversation type changed, the new value is returned
## Delete a participant from a conversation
* Method: `DELETE`
* Endpoint: `/room/{token}/participants`
* Data:
field | type | Description
------|------|------------
`participant` | string | User to remove
* Response:
- Header:
+ `200 OK`
+ `400 Bad Request` When the participant is a moderator/owner and there are no other moderators/owners left.
+ `403 Forbidden` When the current user is not a moderator/owner
+ `403 Forbidden` When the participant to remove is an owner
+ `404 Not Found` When the conversation could not be found for the participant
+ `404 Not Found` When the participant to remove could not be found
## Remove a guest from a conversation
* Method: `DELETE`
* Endpoint: `/room/{token}/participants/guests`
* Data:
field | type | Description
------|------|------------
`participant` | string | Session ID of the guest to remove
* Response:
- Header:
+ `200 OK`
+ `403 Forbidden` When the current user is not a moderator/owner
+ `403 Forbidden` When the target participant is not a guest
+ `404 Not Found` When the conversation could not be found for the participant
+ `404 Not Found` When the target participant could not be found
## Remove yourself from a conversation
* Method: `DELETE`
* Endpoint: `/room/{token}/participants/self`
* Response:
- Header:
+ `200 OK`
+ `400 Bad Request` When the participant is a moderator/owner and there are no other moderators/owners left.
+ `404 Not Found` When the conversation could not be found for the participant
## Join a conversation (available for call and chat)
* Method: `POST`
* Endpoint: `/room/{token}/participants/active`
* Data:
field | type | Description
------|------|------------
`password` | string | Optional: Password is only required for users which are of type `4` or `5` and only when the conversation has `hasPassword` set to true.
* Response:
- Header:
+ `200 OK`
+ `403 Forbidden` When the password is required and didn't match
+ `404 Not Found` When the conversation could not be found for the participant
- Data:
field | type | Description
------|------|------------
`sessionId` | string | 512 character long string
## Leave a conversation (not available for call and chat anymore)
* Method: `DELETE`
* Endpoint: `/room/{token}/participants/active`
* Response:
- Header:
+ `200 OK`
+ `404 Not Found` When the conversation could not be found for the participant
## Promote a user to a moderator
* Method: `POST`
* Endpoint: `/room/{token}/moderators`
* Data:
field | type | Description
------|------|------------
`participant` | string | User to promote
* Response:
- Header:
+ `200 OK`
+ `400 Bad Request` When the participant to promote is not a normal user (type `3`)
+ `403 Forbidden` When the current user is not a moderator/owner
+ `403 Forbidden` When the participant to remove is an owner
+ `404 Not Found` When the conversation could not be found for the participant
+ `404 Not Found` When the participant to remove could not be found
## Demote a moderator to a user
* Method: `DELETE`
* Endpoint: `/room/{token}/moderators`
* Data:
field | type | Description
------|------|------------
`participant` | string | User to promote
* Response:
- Header:
+ `200 OK`
+ `400 Bad Request` When the participant to demote is not a moderator (type `2`)
+ `403 Forbidden` When the current user is not a moderator/owner
+ `404 Not Found` When the conversation could not be found for the participant
+ `404 Not Found` When the participant to demote could not be found
## Set display name as a guest
* Method: `POST`
* Endpoint: `/guest/{token}/name`
* Data:
field | type | Description
------|------|------------
`displayName` | string | The new display name
* Response:
- Header:
+ `200 OK`
+ `404 Not Found` When the conversation is not found or the session does not exist in the conversation
+ `403 Forbidden` When the user is logged in
|
