Skip to navigation

Cancel WebRTC call

Gives up a browser call before its SDP offer was sent, for example when the caller leaves the call screen. The agent reserved for the call is released at once and the call ends as canceled; an agent that never connected is not billed. A call that already started is hung up, as with POST /api/v1/calls/{callId}/end. Canceling an ended call does nothing.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

callIdstringRequiredformat: "uuid"
Call ID

Response

Call canceled (or already ended)

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error