summaryrefslogtreecommitdiffstats
path: root/docs/call.md
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2022-03-29 17:11:41 +0200
committerJoas Schilling <coding@schilljs.com>2022-05-17 10:13:40 +0200
commitc15f9d831872e6be4a8214d7bac1c0725eacd119 (patch)
treefc32c70fa3c15d618d076f45a3b892b789ed93af /docs/call.md
parent43a4e291e278eb3580a54f0d611ee827e0163c23 (diff)
Allow to "Send call notifications"
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs/call.md')
-rw-r--r--docs/call.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/call.md b/docs/call.md
index fba81dfe8..c92a64182 100644
--- a/docs/call.md
+++ b/docs/call.md
@@ -47,6 +47,28 @@
+ `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`