API reference
Every resource, with its endpoints, parameters, object fields and examples. Conventions such as authentication, errors and pagination are on API basics.
| Resource | Endpoints |
|---|---|
| Subaccounts | Create a subaccount, Retrieve a subaccount, List subaccounts, Update a subaccount, Retrieve requirements, Upload a document, Record an attestation, Create a setup link |
| Agents | Create an agent, Retrieve an agent, List agents, Update an agent, Delete an agent, Create an agent token, Create SIP credentials, Create an agent pool, List agent pools |
| Dial sessions | Start a dial session, Retrieve a dial session, List dial sessions, Pause a dial session, Resume a dial session, Stop a dial session |
| Calls | Place a single call, Retrieve a call, List call records, Hold a call, Take a call off hold, Mute the agent, Unmute the agent, Send digits, Transfer a call, Complete a warm transfer, Cancel a transfer, Add people to a call, Remove a participant, Forward a call, Hang up a call, Save a disposition, Start a stream, Stop a media stream, List scheduled callbacks, Cancel a callback |
| Leads and campaigns | Create a lead list, List lead lists, Add leads, List leads in a list, Retrieve a lead, Update a lead, Delete a lead, Create a campaign, Retrieve a campaign, Update a campaign, List campaigns, Store a consent record, Update compliance settings, List calling hours by state, Add to the do-not-call list, Check a number, Upload a state do-not-call list, List state do-not-call lists |
| Numbers | Search available numbers, Buy a number, List numbers, Retrieve a number, Update a number, Retire a number, Release a number, Read number health, Start spam cleaning, Retrieve spam cleaning, Set branded caller ID, Create a caller ID pool, List caller ID pools, Update a caller ID pool, Port numbers in, Retrieve a port, Update a port, Cancel a port, Add a port document |
| Lookups | Look up a number, Look up a batch, Retrieve a batch |
| Recordings | Retrieve a recording, List recordings, Download the audio, Delete a recording, Pause recording, Resume recording, Mark consent, Retrieve recording settings, Update recording settings, Create a retention rule, List retention rules, Delete a retention rule |
| Transcripts | Retrieve a transcript, Search transcripts, Retrieve a summary, Retrieve tonality |
| Messages | Send a message, Retrieve a message, List messages, List messaging lines, Retrieve a messaging line, List opt-outs |
| Webhooks | Create an endpoint, List endpoints, Retrieve an endpoint, Update an endpoint, Delete an endpoint, Rotate the secret, List deliveries, Resend an event, List events, Retrieve an event |
| Billing | Retrieve usage, List invoices, Retrieve an invoice, List call records, Retrieve a call record |