User Calls

Returns the currently running calls for a user. The response is a list of channels with ongoing calls. The map then contains a list of call states for each channel. A call state is essentially a media connection of a browser, e.g. a voice call or screen share.

GET /api/cowork/user/calls

Returns the currently running calls of the current user.

{
    "teamID":              "<GUID of the team having a call>",
    "channelID":           "<GUID of the channel having the call>",
    "states": [
        {
            "userId":      "<GUID of the user who is running the call>",
            "displayName": "<The display name of the user who is running the call>",
            "clientId":    "<The id of the connected client running the call>",
            "media":       "<The media type: camera or screenX>",
            "muted":       "<True, if muted>",
            "silent":      "<True, if client is silenced>",
            "video":       "<True, if client has a video stream active (e.g. webcam)>",
            "handUp":      "<True if the hand is up>"
        },
        ...
    ]
}

RESPONSE Field	Value Type	Description
teamID	String	The GUID of the team where the call takes place
channelID	String	The GUID of the channel where the call takes place
userID	String	The GUID of the user who runs the call
displayName	String	The display name of the user, visible in CoWork
clientId	String	The ID of the client from which the call was initiated. The ID is unique for every browser instance and tab
media	String	The type of media this stream is using. Can be either `camera` (even if only audio is running) or `screenX` with `X` being a number counted up.
muted	Boolean	True, if the user is muted, false otherwise
silent	Boolean	True, if the user disabled sound output, false otherwise
video	Boolean	True, if the user has a video like a webcam active, false otherwise
handUp	Boolean	True, if the user raised a hand, false otherwise

Note: An empty list is returned, when there is no ongoing call.

Example Request

# Request
# Use user:password for authorization
GET /api/cowork/user/calls HTTP/1.1
Accept: */*
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# 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
            }
        ]
    }
]

User Calls

GET /api/cowork/user/calls

Example Request

{{welcome.getConfig().welcomeTitle}}

Help - /calls