REST API basics

The API gives your own software everything the Reports page shows: every call with its journey, summary and transcript, every text and WhatsApp message, faxes, recordings, and your contacts, plus webhooks so events arrive instead of being polled for. Integrations at Vocatech run on it: your developer or a no-code tool such as Zapier, Make or n8n connects what you use. We do not build or host custom integrations.

Getting a key

The key is self-serve. On your company's Integrations page in the portal, press Generate. Pressing it needs a login with the Company Settings and CRM Integrations permissions, which a Basic or Advanced login normally has and a Reports login never does; a developer who cannot see the button is signed in with the wrong login. A key is shown on that page and never emailed. Regenerating replaces it, and the old key stops working at once. The same page can lock the key to your servers' exact addresses; left empty, it works from any address. Texting at volume uses separate API Messaging keys, one per integrator, made under Textdock.

Authentication

Every request carries the key as a bearer token:

curl -H "Authorization: Bearer YOUR_KEY" https://api.vocatech.com/v1/calls

A missing or wrong key answers 401. Every request is scoped to the key's company. Dates default to today in the America/New_York time zone, and a page holds up to 500 records. Call the API from your server, never from a browser or an app: it sends no CORS headers, and a key in a web page is a key anyone can read. GET /v1/whoami shows the address the API sees you as.

What is there

• Calls. Call records for a date range, each with its journey in order, and on recorded calls the AI summary and the transcript on each step. Filter by direction, status, and a search on a number, a name or an extension.
• Messages. Text and WhatsApp history, and sending texts. On a text the status in this list always reads delivered, because the list does not carry carrier receipts; the message.status_updated webhook does. WhatsApp reports a real status. Sending WhatsApp through the API is not available.
• Faxes. Sending and history.
• Media. Message attachments, call recordings and fax documents, each returned as a signed link that works for thirty minutes.
• Contacts. List, create, update and delete the contacts that put names on Callpop and Reports, and look up the contacts behind a number.
• Callers and AI agents. Everything the account knows about one number, the account's AI agents, and one outgoing call placed by an agent.
• Support and knowledge. Open a ticket with us from your own system, or ask a question about our service.
• Webhooks. Create, view, update and delete subscriptions, send a test, and list failed deliveries. See webhooks.

There are no endpoints for call settings. Forwarding, do not disturb, ring settings and the rest are changed in the portal, not from your software. That is a feature not built yet rather than a rule.

Limits

Each kind of request has its own counter on a key. The standard key allows 600 requests a minute, 300 a minute on the call and message reports, and, for sending texts, 20 messages a minute and 200 a day. Faxes, AI agent calls, support tickets and knowledge questions have smaller counters of their own; the developer page lists every one. Faxes are counted per account: 3 a minute and 50 sent a day, each a PDF of at most 25 pages. The fax API is for sending your own documents, not for marketing or bulk faxing. Past a limit the answer is 429 with a Retry-After header; back off and retry. Sending more texts than that is the metered tier on its own key; see texting from your own software.

Getting help

The reference at api.vocatech.com/docs is interactive: paste your key and send real requests from the browser to see the exact response shape. Those requests act on your own account, so a send there really sends; set test to true on a text or a fax for a dry run. The written guide at api.vocatech.com/guide has examples and the webhook details. If you are stuck on an endpoint, call 718.395.1550; the people who built it pick up.