Create a voice Session: a short-lived, single-conversation reservation that lets a client hold a live voice chat with your agent. This is step 1 of 2. Creating the Session does not start any audio on its own; it returns a ws_url that a client then connects to over WebSocket to actually talk.

Call this endpoint from your server with your API key, and return only the ws_url to your client. The API key must never reach the browser. The ws_url is the only thing the client needs, and it is safe to hand out because it is single-use and expires. For how to connect and talk, see "Connect the client and talk" below the request details.

(Tags: Sessions)

Retrieve all agents for the authenticated user with pagination support. (Tags: Agents)

Create a new agent with the provided configuration. The full config supports transcriber, model, voice, web search, transfer, end-call conditions, post-call actions (email + webhook), ambient background track, initial ringing sound, and multilingual support.

Voicemail detection is an access-gated feature that we turn on per account. If it isn't enabled for yours yet, request access before configuring the voicemail object.

(Tags: Agents)

Get details of a specific agent by ID. The response also includes a version_history_enabled boolean showing whether version history is turned on for the agent's organization. (Tags: Agents)

Update an existing agent. Send only the fields you want to change.

Voicemail detection is an access-gated feature that we turn on per account. If it isn't enabled for yours yet, request access before configuring the voicemail object below. (Tags: Agents)

Permanently delete an agent. (Tags: Agents)

List an agent's saved versions, newest first. Includes manual (named) versions, automatic versions, and system backups taken before a restore. (Tags: Agents)

Save the agent's current configuration as a named version. (Tags: Agents)

Delete a saved version. (Tags: Agents)

Rename a saved version or edit its note. Version history is immutable otherwise; only the name and note can change. (Tags: Agents)

Get a record-level diff for this version. By default it shows what changed in this version compared with the version before it. Use against=current to compare with the agent's live config (what restoring this version would change), or against=<number> to compare with another version. (Tags: Agents)

Restore a version onto the live agent. Your current setup is saved first as a backup version, so restoring is undoable. Configuration is brought back; any knowledge files or integrations that were deleted since this version was saved can't be re-linked, and are reported in skipped. (Tags: Agents)

Initiate a call to a phone number using a specified agent. The phone number must include a country code with a leading plus.

(Tags: Calls)

Retrieve call logs with pagination and optional filtering. (Tags: Calls)

Detailed information about a specific call (duration, status, transcript, sentiment, extracted variables). (Tags: Calls)

List bulk-call campaigns with pagination and optional status filter. (Tags: Bulk calls)

Create a new bulk-call campaign. Only name, phone_number_id and a contact_list are needed to dial a list now; every other field adds one behaviour on top (drafts, rotation, filtering, scheduling, retries, dynamic feeding).

The guide below the field reference walks the whole journey: the first campaign and its response, each behaviour with a working request, every refusal message with its fix, and the endpoints that operate a campaign once it runs.

(Tags: Bulk calls)

Push a single contact into a dynamic bulk-call campaign in real time. Dynamic campaigns are created from the dashboard (Bulk Call

Create New Campaign > Dynamic Campaign) and stay alive waiting for contacts, so this webhook is how you feed them from a CRM, form, or automation platform. The contact is queued immediately, and the campaign starts calling it as soon as it is within operating hours.

(Tags: Bulk calls)

Get detailed information about a bulk-call campaign. (Tags: Bulk calls)

Pause, resume, or reschedule a running campaign. (Tags: Bulk calls)

Cancel a bulk-call campaign. (Tags: Bulk calls)

Per-contact results for a campaign: what happened on each call, the variables you sent with that contact, and a pointer to the recording.

Paging

There is one rule. Call it with no cursor, then keep passing back the next_cursor you were handed until it comes back null.

cursor = None
while True:
    page = GET /lines?pagesize=150&cursor={cursor}
    handle(page["records"])
    cursor = page["next_cursor"]
    if not cursor: break

Each call returns a page of rows, oldest first: pagesize goes up to 150 and defaults to 30. Cursors are opaque, so pass back the string you were given and never build one. No contact is skipped or returned twice, even while the campaign is still dialing.

Transcripts are not in the row

Each row carries call.recording_id, not the conversation. Transcripts reach 212 KB, so carrying them here would make one page tens of megabytes. Fetch the one you want from GET /calls/logs/{recording_id}.

(Tags: Bulk calls)

The campaign's number pool, and which number is dialing right now.

calls_this_cycle is what fixed_count rotation compares against, so it is the field to watch for the next rotation. calls_dispatched is the number's lifetime total across every cycle.

(Tags: Bulk calls)

Add one of your numbers to the campaign's rotation pool. Works while the campaign is running, which is how you bring in a fresh number when the pool is running out of healthy ones.

The number must belong to you and must not already be in the pool. A number with no agent attached gets this campaign's agent attached automatically; a number attached to a different agent is refused.

(Tags: Bulk calls)

Stop or resume dialing from one number in the pool.

Pausing is what you want when a number starts going bad mid-campaign: dialing moves to the next number in sequence and the paused number keeps its history and counters. The last active number of a running campaign cannot be paused, since the campaign would have nothing to dial from.

Send the state you want rather than a toggle, so retrying the same request is harmless.

assignment_id is the number's id within this campaign's pool, from List rotation pool. It is not the phone_number_id.

(Tags: Bulk calls)

Add up to 1000 contacts to a campaign in one request.

This is the batch form of Add contact to dynamic campaign. Prefer it whenever you have more than a handful: one request of 500 contacts is far cheaper than 500 requests, on your side and ours.

Repeated numbers are kept, not merged. If the same number appears twice with different variables, it is called twice, because two rows for one number usually means two real reasons to call.

Rows that fail validation are reported in rejected and the rest are still added, so a single bad number does not lose the batch. If the campaign has call_conditions, rows that do not match are added with status Skipped.

(Tags: Bulk calls)

Start a campaign that was created with save_as_draft: true.

Drafts let you build a campaign over several requests: create it, add contacts in batches, set the number pool, set concurrency, then start when everything is in place. A campaign that is already running, scheduled, or finished cannot be started.

(Tags: Bulk calls)

Change how many calls the campaign places at once, including while it is running. Raise it to finish sooner, lower it if your team cannot keep up with transfers or your numbers are being answered less.

The ceiling is your account's concurrency limit.

(Tags: Bulk calls)

Re-queue contacts that did not connect, without creating a new campaign.

Use it after a campaign finishes with more no-answers than you expected, or when the reason was on your side (a bad window, a number that was having a bad day). Retried contacts keep their original variables.

(Tags: Bulk calls)

Restrict a campaign to a daily calling window, in the campaign's timezone. Outside the window the campaign holds rather than finishing, and resumes the next day.

(Tags: Bulk calls)

Real-time status of a running bulk-call campaign. (Tags: Bulk calls)

List all knowledge-base files for the authenticated user. (Tags: Knowledge base)

Check whether a file can be uploaded based on size and type. (Tags: Knowledge base)

Upload a PDF file. The file content must be Base64 encoded. (Tags: Knowledge base)

Attach multiple knowledge-base files to an agent. (Tags: Knowledge base)

Detach multiple knowledge-base files from an agent. (Tags: Knowledge base)

Permanently delete a file. Removes it from any attached agents. Cannot be undone. (Tags: Knowledge base)

Retrieve the phone numbers on your account, whether you bought them from the OmniDimension number shop or imported your own.

(Tags: Phone numbers)

Search the OmniDimension number shop for phone numbers available to buy in a region. Price and validity are flat per region, so every result shows the same monthly_rental_usd and validity_days, and that is the exact amount a purchase will charge.

A region can have more than one carrier, each stocking different number series. Pass the carrier you want; the response names the carrier its results came from, and that is the carrier a purchase has to pass.

(Tags: Phone numbers)

Buy a phone number from the OmniDimension number shop. The monthly rental comes out of your wallet and the number is added to your account, ready to attach to an agent.

(Tags: Phone numbers)

Give up a phone number and stop its rental, so it is not charged at the next renewal. Only a number currently allocated to the account can be released.

(Tags: Phone numbers)

Attach an account-owned phone number to an existing agent. (Tags: Phone numbers)

Detach a phone number from its associated agent. (Tags: Phone numbers)

Import an existing Twilio number by providing your Twilio credentials. (Tags: Phone numbers)

Import an Exotel number by providing your Exotel credentials. (Tags: Phone numbers)

Import a phone number associated with a SIP trunk. (Tags: Phone numbers)

Retrieve all available Large Language Model providers. (Tags: Providers)

Retrieve voices with filtering and pagination support. ElevenLabs supports advanced filtering by name, language, accent, and gender. Other providers support basic pagination only.

(Tags: Providers)

Retrieve all Speech-to-Text providers. (Tags: Providers)

Retrieve all Text-to-Speech providers. (Tags: Providers)

Comprehensive response with services and voices in one payload. (Tags: Providers)

Detailed metadata for a specific voice. (Tags: Providers)