diff options
| author | Joas Schilling <coding@schilljs.com> | 2023-10-13 16:19:38 +0200 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2023-10-23 15:48:01 +0200 |
| commit | 60b0154304db2f4b12f968135eef84815e593dcb (patch) | |
| tree | 7e1db61861e9973922412c6d2b1d3cc0dcd03774 /docs | |
| parent | 2b6cf6c476bd2d4d7115f8761472466bf862cb5e (diff) | |
feat(sip-dialout): Add API endpoint for the SIP bridge to cancel a Dial-out
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/participant.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/participant.md b/docs/participant.md index 99161e011..14624e648 100644 --- a/docs/participant.md +++ b/docs/participant.md @@ -325,6 +325,28 @@ Note: This is only allowed as validate SIP bridge requests - Data: See array definition in `Get user´s conversations` +## Reset call ID of rejected dial-out + +Note: This is only allowed as validate SIP bridge requests + +* Required capability: `sip-support-dialout` +* Method: `DELETE` +* Endpoint: `/room/{token}/rejected-dialout` +* Data: + +| field | type | Description | +|--------------|--------|---------------------------------------------| +| `attendeeId` | int | The attendee ID of the dial-out participant | +| `callId` | string | The call ID that was rejected | + +* Response: + - Status code: + + `200 OK` Call ID reset + + `400 Bad Request` Call ID mismatch + + `401 Unauthorized` SIP request invalid + + `404 Not Found` Participant was not found + + `501 Not Implemented` When SIP or SIP dial-out is not configured + ## Set display name as a guest * API: Only `v1` |