{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Audio
The Audio handler allows to modify properties of an ongoing call. Users can mute a call or switch their client to be silent. The request must be done using POST. The response is the same as in the /calls request, returning the modified connections.
POST /api/cowork/teams/<teamID>/channels/<channelID>/calls/audio
Returns the currently running calls of the selected channel.
{ "muted": "<True, if should be muted>", "silent": "<True, if client should be silenced>", "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 |
|---|---|---|
| muted | Boolean (optional) | True, if the user should be muted, false otherwise. |
| silent | Boolean (optional) | True, if the user wants to disabled sound output, false otherwise |
| clientId | String | The GUID of a client to modify, e.g. if multiple clients of a user are online |
| media | String (optional) | The media type of the connection to modify, can be either camera (also for audio-only connections) or screenX with X being a number |
Note: the clients field is optional. Optional fields can be omitted and will not change the current state.
Example Request
# Request # Use user:password for authorization POST /api/cowork/teams/3n1ytbwme7ngfyn9g9guwwurt/channels/3y8kdto0lnx3ig3mshwvrb9x7/calls/audio HTTP/1.1 Accept: */* Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u { "muted": true, "silent": false } # Response HTTP/1.1 200 OK Content-Type: application/json [ { "userId": "51hsegfzptqm6z3q8c6qkad7a", "displayName": "Jane Doe", "clientId": "cowork-390e29ba-fe73-4dd0-affc-b78ea328769b", "media": "camera", "muted": true, "silent": false, "video": false, "handUp": false } ]
© Copyright 1996 - 2024, i-net software GmbH; All rights Reserved. Imprint
