All endpoints - OnDial API

53 endpoints · Base URL https://dashboard.ondial.ai · Auth Authorization: Bearer ond_live_… (or ond_test_… for test mode).

Create a lead

Push one lead and start the call, WhatsApp or email.

Bulk leads

Send many leads in one request.

Webhooks

Get call status and analysis pushed to you.

Errors

Every reasonCode and what to do.

Authentication

API keys, test mode, scopes.

Quick start

Ping, templates, first lead.

Set up and test

Check your key and see which templates you can use.

Method	Endpoint	What it does
GET	`/ping`	Auth check
GET	`/omni/templates`	List Omni templates

Send leads

Find a campaign, check its lead setup, validate, then create one lead or many.

Method	Endpoint	What it does
GET	`/campaigns`	List outbound campaigns
GET	`/campaigns/{campaignId}`	Get campaign
GET	`/campaigns/{campaignId}/lead-setup`	Lead setup for a campaign
POST	`/leads/validate`	Validate lead (dry run)
POST	`/leads`	Create lead
POST	`/leads/bulk`	Create leads in bulk
GET	`/campaigns/{campaignId}/contacts`	List campaign contacts

Track contacts

What happened to a lead: status, calls, follow-ups, cancel or delete.

Method	Endpoint	What it does
GET	`/contacts/{id}`	Get contact status
GET	`/contacts/{id}/calls`	List dial attempts for a contact
GET	`/contacts/{id}/calls/{callId}`	Get dial conversation + analysis
POST	`/contacts/{id}/followups`	Schedule follow-up
POST	`/contacts/{id}/cancel`	Cancel queued dial/send/follow-up
DELETE	`/contacts/{id}`	Soft-delete contact

Calls and recordings

Live and finished calls, details and signed recording links.

Method	Endpoint	What it does
GET	`/calls`	List unified calls
GET	`/calls/active`	List active calls
GET	`/calls/{id}`	Get call detail
GET	`/calls/{id}/recording`	Get signed recording URL

Webhooks

Get call and lead events pushed to your system.

Method	Endpoint	What it does
GET	`/webhooks`	List tenant webhooks
POST	`/webhooks`	Create or manage webhook
PATCH	`/webhooks`	Update webhook
DELETE	`/webhooks`	Delete webhook

Events

Map your own events to campaigns.

Method	Endpoint	What it does
POST	`/events`	ERP event → mapped campaign
GET	`/event-routes`	List event routes
POST	`/event-routes`	Upsert event route
DELETE	`/event-routes`	Delete event route

Credits and analytics

Wallet balance, credit history and call reports.

Method	Endpoint	What it does
GET	`/credits`	Get credit balance
GET	`/credits/transactions`	List credit transactions
GET	`/analytics/calls`	Call analytics aggregates

Inbound agents

Create and manage agents that answer calls.

Method	Endpoint	What it does
GET	`/inbound-agents`	List inbound agents
POST	`/inbound-agents`	Create inbound agent on owned number
GET	`/inbound-agents/{id}`	Get inbound agent
PATCH	`/inbound-agents/{id}`	Update inbound agent
POST	`/inbound-agents/{id}/generate-script`	Generate inbound agent script
POST	`/inbound-agents/{id}/activate`	Activate or deactivate inbound agent
POST	`/inbound-agents/{id}/sync-doctors`	Sync HMS doctors onto inbound agent
POST	`/inbound-agents/{id}/crm/lookup`	CRM lookup for inbound agent
DELETE	`/inbound-agents/{id}`	Delete inbound agent

Numbers and voices

Voices, the numbers you own and numbers you can buy.

Method	Endpoint	What it does
GET	`/voices`	List TTS voices
GET	`/numbers`	List owned phone numbers
GET	`/numbers/available`	List available pool numbers
POST	`/numbers/purchase`	Purchase pool numbers

Companies

Company profiles used by campaigns and agents.

Method	Endpoint	What it does
GET	`/companies`	List company profiles
POST	`/companies`	Create company profile
GET	`/companies/{id}`	Get company profile
PATCH	`/companies/{id}`	Update company profile
DELETE	`/companies/{id}`	Delete company profile

Knowledge bases

Documents your agents can use.

Method	Endpoint	What it does
GET	`/knowledge-bases/documents`	List knowledge documents
GET	`/knowledge-bases/upload-billing-info`	Knowledge upload billing preview
POST	`/knowledge-bases/documents`	Upload knowledge document
GET	`/knowledge-bases/documents/{fileId}`	Get document metadata
DELETE	`/knowledge-bases/documents/{fileId}`	Delete knowledge document

Create a lead

Bulk leads

Webhooks

Errors

Authentication

Quick start

​Set up and test

​Send leads

​Track contacts

​Calls and recordings

​Webhooks

​Events

​Credits and analytics

​Inbound agents

​Numbers and voices

​Companies

​Knowledge bases

Set up and test

Send leads

Track contacts

Calls and recordings

Webhooks

Events

Credits and analytics

Inbound agents

Numbers and voices

Companies

Knowledge bases