blob: cea0ee5161c809416a6a72467a61208e435eebb4 (
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
|
# Settings API
* Base endpoint: `/ocs/v2.php/apps/spreed/api/v1`
## Set user´s settings
* Method: `POST`
* Endpoint: `/settings/user`
* Data:
field | type | Description
---|---|---
`key` | string | The user config to set
`value` | string/int | The value to set
* Response:
- Status code:
+ `200 OK` When the value was updated
+ `400 Bad Request` When the key or value was invalid
+ `401 Unauthorized` When the user is not logged in
## User settings
Key | Capability | Default | Valid values
---|---|---|---
`attachment_folder` | `config => attachments => folder` | `/Talk` | Path owned by the user to store uploads and received shares. It is created if it does not exist.
`read_status_privacy` | `config => chat => read-privacy` | `0` | One of the read-status constants from the [constants list](constants.md#Participant-read-status-privacy)
## Set SIP settings
* Required capability: `sip-support`
* Method: `POST`
* Endpoint: `/settings/sip`
* Data:
All values must be sent in the same request
field | type | Description
---|---|---
`sipGroups` | array | List of group ids that are allow to enable SIP for a conversation
`dialInInfo` | string | The dial-in information shown in the sidebar and sent in emails
`sharedSecret` | string | The shared secret of the SIP component
* Response:
- Status code:
+ `403 Forbidden` When the user is not an admin
|
