diff options
| author | Joas Schilling <coding@schilljs.com> | 2023-10-10 17:37:34 +0200 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2023-10-23 15:47:59 +0200 |
| commit | fb363778aa59e5bf70cc6348a30ffbb55065820a (patch) | |
| tree | 55c5e47a4c9101b147b7da2a93e08c8e4efde72a /docs | |
| parent | 50b8f4eb389feb3f47c3519e340dbcc54a483442 (diff) | |
feat(call): Add endpoint to send the dial-out request to the HPB
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/call.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/call.md b/docs/call.md index 97bf5deac..e95fadd2f 100644 --- a/docs/call.md +++ b/docs/call.md @@ -77,6 +77,28 @@ + `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 +## Send SIP dial-out request + +* Required capability: `sip-support-dialout` +* Method: `POST` +* Endpoint: `/call/{token}/dialout/{attendeeId}` +* Data: + +| field | type | Description | +|--------------|------|-------------------------| +| `attendeeId` | int | The participant to call | + +* Response: + - Status code: + + `200 OK` + + `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 does not have the "Start call" permission + + `404 Not Found` When the conversation could not be found for the participant + + `404 Not Found` When the target participant could not be found or is not a phone number (Guest, group, etc.) + + `412 Precondition Failed` When the lobby is active and the user is not a moderator + + `501 Not Implemented` When the SIP functionality is not configured + ## Update call flags * Method: `PUT` |