Introduction
Vocalis API
Place and analyse voice calls, manage the contacts you call, and read back what was said, over one REST API with a single key.
Try it
Every endpoint takes the same key in the same header, returns JSON, and pages the same way. Once this request works, the rest of the reference is a list of paths.
Request
curl "https://vocalis.io/api/v1/calls?pageSize=1" \-H "Authorization: Bearer $VOCALIS_API_KEY"
200 OK
{"data": [{"id": "call_8f2c1a","status": "completed","direction": "outbound","to": "+14155551234","durationSeconds": 143,"isAnalyzed": true,"startedAt": "2026-03-04T16:21:08Z"}],"page": 1,"pageSize": 1,"total": 4812}
Base URLhttps://vocalis.io/api/v1
The rules
- headerAuthorization: Bearer
- One key per organization, created under Settings → API Keys. A key reads and writes only the organization it was made in.Authentication →
- querypage, pageSize
- Collections are paged, up to 100 per page, and every list response carries
totalalongside the rows. - limit60 / min, 10,000 / day
- Per key, reported on every response in the
X-RateLimit-*headers.Rate limits → - jsonerror.code
- Failures are a machine-readable code and a sentence, never a bare status, branch on the code, show the sentence.Errors →
The surface
Each area is documented end to end: every parameter, every response, and the capability a key needs to call it.
Contact listsWho to call, and what the platform knows about them.ContactsGetting people into a list, one batch or one file at a time.ConsentsRecords of a person agreeing to be called or texted at a number.Import jobsWhat happened to contacts you handed over.CampaignsThe unit of calling work: who to call, with which agent, and when.CallsEvery conversation the platform has had, and what came out of it.AnalyticsHow the calling went, at whatever grain you need.Call IntelligenceWho was speaking, how the call sounded, and what we learned about them.Events & streamingWatch calls as they happen, and resume exactly where you left off.WebhooksBe told when something happens, instead of asking.AgentsCreate, edit and version the thing that actually talks to people.Connected agentsAgents you run on another platform, answering calls on your Vocalis numbers.ToolsThe HTTP calls an agent can make while it is on a call.Knowledge basesThe documents an agent can look things up in, mid-call.EvalsTest an agent against real situations, including ones it has already been in.Call centersThe human side: who is staffing, and what they are handling.Call center QAScorecards, call scores, automatic scoring and the reporting built on them.Help desksThe support inbox: desks, conversations, messages, and their events.Help desk configurationThe people, teams, tags, fields, brands, hours, SLAs, views and routing behind a desk.Help desk automationMacros, triggers, automations, AI agents and AI assist for a help desk.Help centerArticles, collections and news for a help desk's help center and widget.Help desk operationsContacts, the embeddable widget, file attachments, reactions, the queue, and how the desk is doing.Phone numbersFind a number, buy it, configure how it behaves, give it back.IntegrationsThe organization's contact center and post-call integrations, read-only.ReportsThe analyses people build over their call data, readable as data.TracesWhere a call's time and cost actually went.