Phones - Calls

Cancel scheduled calls

Cancel one or more scheduled calls by their IDs. Only calls with status "scheduled" or "to_be_processed" can be cancelled; calls that already started or completed are reported as already processed.

Request:

  • callIds: Array of 1–100 call IDs. Get the IDs from the scheduled-calls list endpoint or from the initiate-call/initiate-bulk response.

Response: Aggregate counters (totalRequested, cancelled, alreadyProcessed, notFound) plus per-call results with a reason for each failure. Cancellation is partial: valid IDs are cancelled even if others in the same request fail.

Note: Cancelled calls are marked as cancelled with end reason "Cancelled by user" and are not retried.

post/api/v1/phones/calls/cancel-scheduled

Request

  • Base URL: https://api.voicelogica.ai
  • URL: https://api.voicelogica.ai/api/v1/phones/calls/cancel-scheduled
  • Auth: API key in header x-api-key

Headers

x-api-keystring required

Your API key for authentication. Required for all endpoints.

x-company-idstring

Optional company ID for resellers. When provided, the API request will operate on behalf of the specified subsidiary company. The API key must have access to the specified company.

Request body

callIdsstring[] required

Array of call IDs to cancel (1–100). Use leads_query (action "get_scheduled_calls") to find the IDs.

Response

Cancellation processed — per-call results returned

totalRequestednumber required

Number of call IDs provided

cancellednumber required

Number of calls successfully cancelled

alreadyProcessednumber required

Number of calls that were already processed (not scheduled)

notFoundnumber required

Number of call IDs that were not found

Example response

{
  "totalRequested": 2,
  "cancelled": 1,
  "alreadyProcessed": 1,
  "notFound": 0,
  "results": [
    {
      "callId": "507f1f77bcf86cd799439011",
      "success": true
    },
    {
      "callId": "507f1f77bcf86cd799439014",
      "success": false,
      "reason": "Call is already answered"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.