Reference
API Reference
260 endpoints across 26 areas. Each area page documents every parameter, every response, and the capability a key needs.
Everything in common
Base URLhttps://vocalis.io/api/v1
- Authorization: Bearer
- The same key on every request, bound to one organization.
- Content-Type: application/json
- Required on anything with a body. Responses are always JSON.
- page, pageSize
- Collections are paged, up to 100 a page, with
totalalongside the rows. - error.code
- Failures carry a stable code and a human sentence.
Areas
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.