{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Leave
The Leave handler allows the user to leave an ongoing call. The request must be done using POST. The response is always empty.
POST /api/cowork/user/calls/leave
Leaves the ongoing call.
{ "clients": [ { "clientId": "<GUID of the client that should be modified>", "media": "<The media type of the connection that should be modified.>" }, ... ] }
| REQUEST Field | Value Type | Description |
|---|---|---|
| clientId | String | The GUID of a client to leave the call, e.g. if multiple clients of a user are online |
| media | String (optional) | The media type of the connection to close, can be either camera (also for audio-only connections) or screenX with X being a number |
Note: the clients field is optional. If omitted, all calls of the user will be ended.
Example Request
# Request # Use user:password for authorization POST /api/cowork/user/calls/leave HTTP/1.1 Accept: */* Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 200 OK
© Copyright 1996 - 2024, i-net software GmbH; All rights Reserved. Imprint
