Hang up

POST https://connect.suryojasvi.com/api/v1/calls/{call_id}/leave

Leave a call. The caller giving up before anyone answers ends the call for everyone; anyone else leaving ends it only if they were the last one in it.

Changes: New in Zulip 13.0 (feature level ZF-6022cf).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX POST https://connect.suryojasvi.com/api/v1/calls/1/leave \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode reason=no_answer

Parameters

call_id integer required in path

Example: 1

The ID of the call to act on.


reason string optional

Example: "no_answer"

Pass "no_answer" to end a call that rang until it timed out, so that it is recorded as unanswered rather than as the caller hanging up. Someone being rung for a call already in progress passes it when their ring times out, to record that they missed it.

Changes: The latter is new in Zulip 13.0 (feature level ZF-dd4ee5).


Response

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}