Skip to content
Get started

Cancel a call

call.cancel(strid) -> CallCancelResponse
POST/call/{id}/cancel

Stop a call’s future attempts. A call that has not started dialing yet is cancelled right away. A call whose attempt is already in progress is not hung up: that attempt finishes, and no retry or callback is scheduled after it. Returns 409 when the call is already in a terminal status.

ParametersExpand Collapse
id: str
ReturnsExpand Collapse
class CallCancelResponse: …
success: bool

Cancel a call

import os
from revox import Revox

client = Revox(
    api_key=os.environ.get("REVOX_API_KEY"),  # This is the default and can be omitted
)
response = client.call.cancel(
    "id",
)
print(response.success)
{
  "success": true
}
Returns Examples
{
  "success": true
}