Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Voice

Schedule Callback

Flag the call for a callback. The free-text `preferred_time` is read in the lead's time zone and, when telephony is configured, an AI callback call is queued for then (compliance re-checked when it runs); otherwise the lead gets a task note for a human (RO-134).

API key access

This route has its own authentication (or none); an API key is not used here.
POST/api/v1/calls/{call_id}/callbacks

Authorization

AuthorizationBearer <token>

Per-call token issued when the call was created (job metadata api_token).

In: header

Path Parameters

call_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

Workspace of the call (must match the token).

Request Body

lead_idstring
Formatuuid
preferred_time?string
Default""
Lengthlength <= 200
reason?string
Default""
Lengthlength <= 2000

Response Body

curl -X POST "http://localhost:8000/api/v1/calls/497f6eca-6276-4993-bfeb-53cbbbba6f08/callbacks" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0"  }'
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Save Answer

Save one qualification answer. 422 for a field this call doesn't collect.

Start Test Call

Talk to the live voice agent from the browser, without a phone line (admin+). Creates a call clearly marked as a test (`is_test`, no phone number), dispatches the voice agent (`VOICE_LIVEKIT_AGENT_NAME`) into a new LiveKit room with the normal call metadata (the lead, persona, `language` (the one sent, else the lead's), provider overrides) and returns a participant token for the browser. Nothing is dialled: the telephony checks (consent, calling windows, caps) don't apply, and the call never counts toward the caps or analytics (no timeline events, suppressions, meetings, callbacks, tasks or AI analysis). At most `VOICE_TEST_CALLS_PER_DAY` (20) per workspace and UTC day (429 after). 503 without LiveKit.