Cancel a call

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 can no longer be cancelled: its conversation is over and being analysed (post_processing), or it is in a final status.

Request

curl -X POST "https://www.getrevox.com/api/call/8d2f6b1a-4c9e-4f37-b215-6a0e9c3d7f12/cancel" \
  -H "Authorization: Bearer $REVOX_API_KEY"

const res = await fetch("https://www.getrevox.com/api/call/8d2f6b1a-4c9e-4f37-b215-6a0e9c3d7f12/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.REVOX_API_KEY}`,
  },
});
const data = await res.json();
console.log(data);

import os

import requests

response = requests.post(
    "https://www.getrevox.com/api/call/8d2f6b1a-4c9e-4f37-b215-6a0e9c3d7f12/cancel",
    headers={"Authorization": f"Bearer {os.environ['REVOX_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

Try itSend this request live

Response

Success

{ "success": true }

{
  "message": "Request validation failed",
  "bodyErrors": {
    "issues": [
      {
        "path": ["phone_number"],
        "message": "Invalid input: expected string, received undefined",
        "code": "invalid_type"
      }
    ]
  }
}

{ "error": "Not found" }

{ "error": "Conflicts with the resource's current state" }

Path parameters

idstringrequired
ID of the call, as returned by POST /call or POST /call/search.

Request body

No body: send the request without one.

Response

200

successboolean
True when the operation succeeded.

Errors

400Invalid request: a field or parameter failed validation{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }
404Not found in your organization{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }
409Conflicts with the resource's current state{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }

Error bodies carry an error (or message) string; a 400 adds bodyErrors.issues. See Errors.