Decline a call

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

Turn down a ringing call. A call everyone has declined is over; one that somebody else may still answer goes on ringing them.

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/decline \
    -u EMAIL_ADDRESS:API_KEY

Parameters

call_id integer required in path

Example: 1

The ID of the call to act on.


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"
}