{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Video
The Video handler allows to enable or disable output from a video camera of an ongoing call. The request must be done using POST
. The response is the same as in the /calls request, returning the modified connections.
POST /api/cowork/user/calls/video
Enables or disables the camera of an ongoing call.
{ "video": "<True, if the camera should be enabled>", "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 |
---|---|---|
video | Boolean (optional) | True, if the camera of the user should be enabled, 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. If omitted, all user connections will be modified.
Example Request
# Request # Use user:password for authorization POST /api/cowork/teams/3n1ytbwme7ngfyn9g9guwwurt/channels/3y8kdto0lnx3ig3mshwvrb9x7/calls/audio HTTP/1.1 Accept: */* Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u { "video": true, } # Response HTTP/1.1 200 OK Content-Type: application/json [ { "teamId": "z1hc4tcuiitho9g37x3rbcjj2", "channelId": "x67aca5q3kvwyhebed0tey5ab", "states": [ { "userId": "51hsegfzptqm6z3q8c6qkad7a", "displayName": "Jane Doe", "clientId": "cowork-390e29ba-fe73-4dd0-affc-b78ea328769b", "media": "camera", "muted": true, "silent": false, "video": false, "handUp": false } ] } ]