diff options
| author | Joas Schilling <coding@schilljs.com> | 2021-10-07 20:34:55 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2021-10-11 17:26:08 +0300 |
| commit | 0c379ce84611f6a1c464c8d44ee96dd476621fcc (patch) | |
| tree | 7d9a7d84d02353f2cc9c20ca55e0ec8a75339811 /docs | |
| parent | f772525127c6c60ac64d605258b977fb5604f942 (diff) | |
Add API to opt out of call notifications
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/capabilities.md | 1 | ||||
| -rw-r--r-- | docs/constants.md | 4 | ||||
| -rw-r--r-- | docs/conversation.md | 18 |
3 files changed, 23 insertions, 0 deletions
diff --git a/docs/capabilities.md b/docs/capabilities.md index e26e40889..ce9739805 100644 --- a/docs/capabilities.md +++ b/docs/capabilities.md @@ -84,3 +84,4 @@ title: Capabilities ## 13 * `direct-mention-flag` - The conversation list populates the boolean `unreadMentionDirect` when the user was mentioned directly (ignoring @all mentions) since their last visit +* `notification-calls` - Whether the API to opt out of call notifications is available diff --git a/docs/constants.md b/docs/constants.md index 90423a13e..7dea4199c 100644 --- a/docs/constants.md +++ b/docs/constants.md @@ -46,6 +46,10 @@ title: Constants * `2` Notify on mention * `3` Never notify +### Participant call notification levels +* `0` Off +* `1` On (default) + ### Participant read status privacy * `0` Read status is public * `1` Read status is private diff --git a/docs/conversation.md b/docs/conversation.md index d5ad7c95b..1984df9eb 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -309,6 +309,24 @@ + `401 Unauthorized` When the participant is a guest + `404 Not Found` When the conversation could not be found for the participant +## Set notification level for calls + +* Required capability: `notification-calls` +* Method: `POST` +* Endpoint: `/room/{token}/notify-calls` +* Data: + + field | type | Description + ---|---|--- + `level` | int | The call notification level (See [Participant call notification levels](constants.md#Participant-call-notification-levels)) + +* Response: + - Status code: + + `200 OK` + + `400 Bad Request` When the given level is invalid + + `401 Unauthorized` When the participant is a guest + + `404 Not Found` When the conversation could not be found for the participant + ## Open a conversation * Required capability: `listable-rooms` |