Calls
A call is one run of an agent on a phone line. Start one from your backend, list what happened, and fetch the transcript, recording and outcome.
| Method | Route | What it does |
|---|---|---|
calls.start | POST /api/v1/public/agent/{uuid} | Place a call with an agent, by its public id. |
calls.startTest | POST /api/v1/public/agent/test/{uuid} | Place a test call that runs the draft. |
calls.startByWorkflow | POST /api/v1/public/agent/workflow/{workflow_uuid} | Place a call by workflow id. |
calls.create | POST /api/v1/workflows/{workflow_id}/runs | Create a run for an agent (voice, text or web). |
calls.list | GET /api/v1/workflows/{workflow_id}/runs | Runs of one agent, newest first. |
calls.get | GET /api/v1/workflows/{workflow_id}/runs/{run_id} | One run: status, outcome, artifacts. |
calls.listAll | GET /api/v1/organizations/usage/runs | Every run in the account, across agents, with cost. |
calls.artifact | GET /api/v1/public/download/workflow/{token}/{artifact_type} | Download a recording or transcript with a signed token. |
calls.initiate | POST /api/v1/telephony/initiate-call | Dial a number with an agent through a telephony configuration. |