summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/participant.md22
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`