# Voxworks

- [Getting Started](https://docs.voxworks.ai/index.md): Learn about Voxworks, the enterprise platform for building AI voice assistants that automate customer conversations.
- [Quickstart: Build & Test Your First AI Agent](https://docs.voxworks.ai/getting-started/quickstart.md): The shortest path from an empty account to a working voice agent — create a call script, hear it on a test call, publish it, put it on your number for inbound, place your first outbound call, and read the results.
- [Onboarding Walkthrough](https://docs.voxworks.ai/getting-started/onboarding.md): Every step of the Voxworks welcome wizard — personal details and SMS verification, team setup, AI script generation with a test call, your reserved phone number, and billing with $0 charged today.
- [Free Trial](https://docs.voxworks.ai/getting-started/free-trial.md): How the Voxworks free trial works — 14 days and 100 free minutes, tracking your usage, the 14-day phone number hold, and what happens when the trial ends.
- [Environments: Test vs Live](https://docs.voxworks.ai/getting-started/environments.md): Every call in Voxworks runs in one of two environments — Test or Live. Learn how calls, phone numbers, and integration connections carry an environment, how activity ends up in Test, and how to keep test data out of your production reporting.
- [Using the In-App Assistant](https://docs.voxworks.ai/assistant/in-app.md): Open the Voxworks assistant from any team page, ask in plain language, attach documents, and pick up earlier conversations.
- [What the In-App Assistant Can Do](https://docs.voxworks.ai/assistant/in-app-capabilities.md): Everything the in-app Voxworks assistant can do: create scripts and surveys, propose script changes, work through recommendations, explain calls, diagnose campaigns and answer account questions.
- [Setup Assistant](https://docs.voxworks.ai/assistant/setup-assistant.md): The assistant on the welcome pages that helps new accounts finish setup, builds a first agent from their website and starts a test call.
- [Scripts](https://docs.voxworks.ai/scripts/overview.md): Scripts are the foundation of every Voxworks voice assistant that defines persona, conversation structure and behaviour. Scripts are comprised of a main flow, sub-flows, steps, conditions, and branching paths.
- [Creating a Script](https://docs.voxworks.ai/scripts/creating-a-script.md): How to create a new call script in Voxworks — generate one with AI, start from a template, copy an existing script, or build from scratch — and how to read the Scripts page.
- [AI Script Generation](https://docs.voxworks.ai/scripts/ai-generation.md): Generate a complete call script or AI receptionist from a short description, grounded in your website content and uploaded documents — then keep improving it with AI recommendations in the editor. Covers the generation inputs, file limits, the live progress log, website research, failures, and the r…
- [Script Editor Guide](https://docs.voxworks.ai/scripts/editor-guide.md): A tour of the script editor: the five editor tabs and their shareable deep links, the Overview tab's performance view, the title-row voice switcher, saving and the unsaved-changes guard, the multi-flow editor with Pre-Call flows and stages, drag-and-drop, shared-flow editing choices, and PDF export.
- [Settings](https://docs.voxworks.ai/scripts/settings.md): Script Settings configure operational parameters for your voice assistant: call type, call duration, voicemail, voice and key terms, Live Handoff, Intent Pathways, shared classifiers, post-call automations, and deleting the script.
- [Script Versions & Publishing](https://docs.voxworks.ai/scripts/versions-and-publishing.md): Every save of a script creates a numbered version. Learn how Draft and Live versions work, how to publish to production, how to browse and compare version history with an AI change summary, and which version each call actually runs.
- [Testing Your Script](https://docs.voxworks.ai/scripts/testing.md): How the editor's Test Call loop works — the silent draft save, the preparation stages, and the validation errors that block a save — and where the Test Console fits in, so you can hear every change before it goes live.
- [Test Console](https://docs.voxworks.ai/scripts/test-console.md): Put a script through many conversations at once: saved scenarios you re-run after every change, replays of real calls, AI-generated personas, and agent-to-agent test runs with real side effects switched off.
- [Call Objectives](https://docs.voxworks.ai/scripts/call-objectives.md): Call Objectives are itemised goals that define what success looks like for each call. After a call ends, the transcript is automatically reviewed against these objectives to measure how well the conversation achieved its purpose.
- [Guidelines](https://docs.voxworks.ai/scripts/guidelines.md): Guidelines are conditional rules for handling soft edge cases during a conversation — situations that might not fit neatly into your main conversation flow.
- [Knowledge Base](https://docs.voxworks.ai/scripts/knowledge-base.md): The Knowledge Base is a list of questions and the answers your assistant gives when a caller asks them. The assistant answers from your response in its own words, fitted to the conversation.
- [Data Collection](https://docs.voxworks.ai/scripts/data-collection.md): Define the structured fields Voxworks extracts from every call's transcript after it ends — for reporting, exports, automations and the API. Configured under Post-Call Analysis → Data Collection.
- [Post-Call Analysis](https://docs.voxworks.ai/scripts/post-call-analysis.md): Configure the structured analysis the AI produces after every call: the outcome classification, the standard fields, the Update contact name setting, follow-up notifications, and up to 20 custom questions answered from the transcript.
- [Voicemail Message](https://docs.voxworks.ai/scripts/voicemail-message.md): Choose what your assistant does when an outbound call reaches voicemail — hang up, leave a spoken message, send a text, or switch detection off — and write the message it uses.
- [Live Handoff (Warm Transfer)](https://docs.voxworks.ai/scripts/live-handoff.md): Live Handoff is a script-wide safety net: when a caller asks for a human, the assistant offers a warm transfer to a routing endpoint, checks the endpoint's availability, and connects the caller with a private briefing first. This page covers the full settings section and what happens on the call.
- [Intent Pathways](https://docs.voxworks.ai/scripts/intent-pathways.md): Intent pathways listen for what the caller really wants mid-call, confirm it, and redirect them to the right flow and step in your script — with optional conditions on call variables, open/closed-hours branching driven by a routing endpoint's schedule, and a choice of where the caller lands when the…
- [Compliance Policies](https://docs.voxworks.ai/scripts/compliance-policies.md): Compliance policies are plain-language rules, managed in the script editor under Behaviour & Knowledge → Policies, that the assistant's responses are checked against before they are spoken. A response that breaks a rule is held back and regenerated, and check results are recorded on the call.
- [Script Text Functions](https://docs.voxworks.ai/scripts/text-functions.md): Text functions are tags you type straight into a script line: rand-pick varies the wording, rand-sort rotates the order options are read out, and bool shows or hides text based on a condition. This page covers the exact syntax and evaluation rules for all three.
- [Conversational Flows](https://docs.voxworks.ai/flows/overview.md): Flows are the heart of your voice assistant's conversation logic that defines structure, branching paths, and decision points. Flows are comprised of steps, conditions, and branching paths.
- [Main Flows](https://docs.voxworks.ai/flows/flows-main.md): The Main Flow is the entry point for every conversation. It defines the primary path your assistant follows from the moment a call connects until it ends.
- [Sub-Flows](https://docs.voxworks.ai/flows/flows-sub.md): Sub-Flows are modular conversation branches that can be invoked from any flow. They enable reusable, maintainable conversation designs.
- [Steps Overview](https://docs.voxworks.ai/flows/steps.md): Steps are the building blocks of every flow. Each step represents a single action in your conversation — speaking to the user, executing logic, calling a service, or navigating to another flow.
- [Voice Steps](https://docs.voxworks.ai/flows/steps-voice.md): Voice Steps are the primary interactive component in your flows. They speak to the user, listen for a response, and navigate based on what the user says.
- [Tool Steps](https://docs.voxworks.ai/flows/steps-tool.md): Tool Steps execute external integrations during your conversation — booking appointments, sending SMS messages, performing warm handoffs, and more.
- [Flow Steps](https://docs.voxworks.ai/flows/steps-flow.md): Flow Steps navigate to sub-flows, enabling modular and reusable conversation designs.
- [Variables](https://docs.voxworks.ai/flows/variables.md): Variables store and pass values throughout a call. Use them whenever a script, tool, condition, response map, or code step needs to read or write data captured during the conversation.
- [Conversation Dynamics](https://docs.voxworks.ai/conversation-dynamics/overview.md): Conversation Dynamics control the timing and behavior of your voice assistant during real-time interactions. These settings determine how quickly the assistant responds, how long it waits for user input, and how deeply it reasons about responses.
- [Response Eagerness](https://docs.voxworks.ai/conversation-dynamics/response-eagerness.md): Response Eagerness controls how quickly your agent responds after a user stops speaking. It's a key setting for achieving natural conversation timing.
- [Thinking Effort](https://docs.voxworks.ai/conversation-dynamics/thinking-effort.md): Thinking Effort controls how deeply the AI reasons when generating responses. Higher effort produces more thoughtful responses but takes longer; lower effort is faster but more straightforward.
- [Silence Tolerance](https://docs.voxworks.ai/conversation-dynamics/silence-tolerance.md): Silence Tolerance controls how your agent handles periods of user inactivity. It determines when to prompt users who have gone quiet and when to gracefully end calls that have stalled.
- [Interruptions](https://docs.voxworks.ai/conversation-dynamics/interruptions.md): Decide whether the caller can talk over a step: the Interruptions menu (Normal, Uninterruptible, Uninterruptible turn, Allow skip), the Verbatim threshold, and the call.step variables that tell a later step whether the last line was actually heard.
- [Fast Response](https://docs.voxworks.ai/conversation-dynamics/fast-response.md): Fast Response decides whether a step waits for the caller to reply or moves straight on. Leave it on Auto to decide from the line itself, or pin it with Force, Disable or a variable.
- [Key Terms](https://docs.voxworks.ai/conversation-dynamics/keywords.md): Key Terms improve transcription accuracy for words that matter to your script — brand names, product names and jargon the speech recogniser would otherwise mishear. Set them for the whole script, or step by step.
- [Assistant Behaviour](https://docs.voxworks.ai/conversation-dynamics/assistant-behaviour.md): The assistant's behaviour is shaped by what you write in your Script — flows, guidelines, and knowledge base content all influence how it responds. However, some behaviours are inherently variable or limited by the underlying technology.
- [AI Receptionist Overview & Quickstart](https://docs.voxworks.ai/receptionist/overview.md): What an AI receptionist is, how to create one with AI generation, and how the simplified editor's setup checklist, Ready status, and call stats take you from zero to answering inbound calls.
- [Receptionist Number & Call Forwarding](https://docs.voxworks.ai/receptionist/phone-number.md): Choose how callers reach your AI receptionist — answer on a Voxworks number directly, or keep your existing number and forward it using the carrier instructions generated in the editor.
- [Configuring Your Receptionist](https://docs.voxworks.ai/receptionist/configuration.md): Give your AI receptionist a name, a voice, a greeting and instructions, switch on what she can do — booking, message taking and warm transfers — and learn how her settings round-trip safely with the full script editor.
- [Receptionist Knowledge & Post-Call Summaries](https://docs.voxworks.ai/receptionist/knowledge-and-summaries.md): Teach your AI Receptionist the facts and FAQ answers it uses on calls — by hand or by researching your website — and switch on automatic Email and SMS summaries after every call.
- [AI Voicemail](https://docs.voxworks.ai/receptionist/ai-voicemail.md): How Voxworks replaces traditional voicemail: your AI receptionist answers the calls you miss, takes a real message, and delivers the transcript, recording and summary to your team.
- [Voice Library](https://docs.voxworks.ai/voices/library.md): Browse and audition the full catalogue of Voxworks voices, then choose the voice callers hear on each call script and AI receptionist.
- [Dashboard & Call Analytics](https://docs.voxworks.ai/dashboard/overview.md): Your team dashboard at a glance — the filters bar, Overview tiles and trend chart, the Activity feed, Performance by handler, Objectives, Call outcomes, and the PDF export.
- [Live Calls & Real-Time Monitoring](https://docs.voxworks.ai/calls/live-monitoring.md): Watch calls as they happen: the Active Calls metrics bar in the header, live updates in the Calls table, streaming transcripts, and the docked player's live controls — Live listen, Take over, Trigger handoff and Cancel call.
- [Saved Views & Table Customization](https://docs.voxworks.ai/dashboard/saved-views.md): Save filter, sort and search combinations as reusable view tabs on the Calls, Batches, Contacts and Lists tables, and keep them up to date with Save View and Update View.
- [Call History](https://docs.voxworks.ai/calls/history.md): How to find, filter, tag, inspect and export every call your team has made or received using the Calls table.
- [Call Details](https://docs.voxworks.ai/calls/call-details.md): Everything the Call Details panel shows for a single call — the recording waveform, the Details, Transcript, Data and Notes tabs, Call Analysis and outcome editing, end reasons, bilingual transcripts, flagging and test scenarios, system notes, the Variables tree and PDF export.
- [Media Player](https://docs.voxworks.ai/calls/media-player.md): The player docked at the bottom of every page: opening recordings and live calls, playback speed and skipping, the expanded view with a scrolling transcript and speaker picker, waveform colours, browser test calls, and the phone layout.
- [Scheduling & Managing Calls](https://docs.voxworks.ai/calls/scheduling-calls.md): Schedule a one-off outbound call from the New Call modal, understand the checks that run before a call is accepted, learn what is locked in at scheduling time versus dial time, manage scheduled calls with reschedule, cancel and retry, and how callbacks the contact asked for are booked.
- [Test Calls](https://docs.voxworks.ai/calls/test-calls.md): How test calls work from the operations side — where to launch them, the My Phone and In Browser modes, the Do Not Call Register exemption, and the Test badge and Environment filter in the Call Log.
- [Web Calls](https://docs.voxworks.ai/calls/web-calls.md): What browser-based web calls are, how they start and end, how each web caller gets their own contact, handing a web call to a human, and why they are never retried.
- [Call Statuses, End Reasons & Outcomes Reference](https://docs.voxworks.ai/calls/statuses.md): The canonical reference for every state a Voxworks call can be in: the status pipeline, end reasons, dispatch status notes, post-call outcome taxonomies, Success Evaluation, and exactly what you can cancel, reschedule, or retry in each status.
- [Dispatch, Concurrency & Delays](https://docs.voxworks.ai/calls/dispatch-and-concurrency.md): How outbound calls move from the queue to a live dial: the dispatch window, dispatch status messages, concurrent-call limits by plan and hourly rates, which numbers can be dialled, delay warnings, and transient vs permanent dispatch failures.
- [Batches: Overview & Lifecycle](https://docs.voxworks.ai/batches/overview.md): What a batch is, how to create one, the batch edit page and its tabs, the header actions, and the full lifecycle from draft through launch to automatic completion.
- [Adding Contacts to a Batch](https://docs.voxworks.ai/batches/adding-contacts.md): How to get contacts into a batch at every stage of its life — staging drafts from source lists, adding calls to a launched batch through the four staging tabs, and reactivating completed batches.
- [Source Lists, Allocation & A/B Testing](https://docs.voxworks.ai/batches/source-lists.md): Feed a batch from one or more contact lists, control how daily calling capacity splits across them with priorities and quotas, override the Call Script and outbound number per list, and run A/B script tests.
- [Batch Scheduling & Pacing](https://docs.voxworks.ai/batches/scheduling.md): How a batch decides when to call — business hours, timezones and holidays, daily caps and ramp profiles, the minimum gap, launch modes, the schedule window, callbacks and pinned contacts, and the forecast in the Schedule panel.
- [Batch Calling Rules & Retries](https://docs.voxworks.ai/batches/calling-rules.md): Configure how a batch handles calls that don't connect: screening gates, the per-outcome retry timeline, callbacks the contact asked for, cancelling retries when a contact calls you back, and the end-of-day summary email.
- [Batch Screening Gates](https://docs.voxworks.ai/batches/screening-gates.md): How batch contacts are screened against the Do Not Call Register, opt-outs and prior call history before dialling — including fail-closed behaviour, re-check timing and the Screen action.
- [Batch Queue Management](https://docs.voxworks.ai/batches/queue.md): How to read and manage a batch's queue — statuses, the Scheduled column's estimates, the Table and Kanban views, bulk Pause/Resume/Cancel/Screen actions, held and pinned items, priorities, CSV export and the audit trail.
- [Batch Analytics & Data Export](https://docs.voxworks.ai/batches/analytics.md): How to read a batch's results — headline metrics, end-reason charts, objectives, the call-outcome breakdown and the calls table — and how to export the data your agent collected as a CSV.
- [Contacts Overview](https://docs.voxworks.ai/contacts/overview.md): A tour of the Contacts workspace: table columns, DNCR status icons, the Lists side panel, the custom variables view, filters, saved views, search and deep links.
- [Contact Records & Fields](https://docs.voxworks.ai/contacts/records.md): Every field on a Voxworks contact record — validation rules, Australian phone normalisation, inline editing, the DNCR readout and override, linked custom variables, per-contact call history, and how your team members appear as contacts.
- [Importing & Exporting Contacts (CSV)](https://docs.voxworks.ai/contacts/import-export.md): How to bulk-import contacts from a CSV file — flexible column headings, duplicate handling, and typed custom-variable mapping — and how to export a filtered contact list that can be re-imported later.
- [Contact Tags](https://docs.voxworks.ai/contacts/tags.md): Create coloured team tags, assign them to contacts inline from the Contacts table or the contact detail panel, tag individual calls, and filter by tag.
- [Contact Bulk Actions](https://docs.voxworks.ai/contacts/bulk-actions.md): Select multiple contacts and act on them at once — add them to a list, assign a custom variable value, wash their numbers against the Do Not Call Register, or delete them.
- [Lists](https://docs.voxworks.ai/lists/overview.md): Create and manage contact lists, add contacts from CSV files, existing lists, your contact book or a membership rule, check Do Not Call Register status, and feed lists straight into outbound batches.
- [List Membership Rules](https://docs.voxworks.ai/lists/membership-rules.md): Let a list fill itself: set the conditions a contact has to meet, check who matches, choose how often the rule re-checks, run or pause it, read its run history, and feed the list straight into an outbound batch.
- [DNCR Washing](https://docs.voxworks.ai/contacts/dncr-washing.md): Check your contacts' phone numbers against the Australian Do Not Call Register — run washes, read the status badges, understand the 30-day freshness window, the pre-call block, and overrides.
- [Opt-Outs](https://docs.voxworks.ai/contacts/opt-outs.md): How Voxworks records a number that has asked not to be called again, why opt-outs are account-level and survive contact deletion, how the opt-out screening gate keeps them out of future batches, and how opt-outs relate to the Do Not Call Register.
- [Phone Numbers](https://docs.voxworks.ai/numbers/overview.md): Claim Australian phone numbers from the Voxworks inventory pool, name them, assign the inbound script that answers them, and release them safely — plus how trial numbers and the 14-day hold work.
- [Service Addresses & Regulatory Verification](https://docs.voxworks.ai/numbers/service-addresses.md): Why every assigned phone number needs a team service address, how to add and manage addresses, and how Australian business verification statuses work.
- [Forward Your Existing Number](https://docs.voxworks.ai/numbers/forward-existing-number.md): The canonical carrier dial-code guide for pointing your existing business number at Voxworks — Telstra, Optus, and Vodafone mobiles, landlines, and PBX/VoIP systems, with activation, ring-time, and deactivation codes.
- [Outbound Caller ID & Default Number](https://docs.voxworks.ai/numbers/caller-id.md): Which of your phone numbers shows as caller ID on outbound calls, how the from-number is chosen in the New Call modal, batches, automations and the API, and what happens when no number can be resolved.
- [SIP Trunking & BYO Carrier](https://docs.voxworks.ai/numbers/sip-trunking.md): How Voxworks connects your calls to the phone network, what that means for bringing your own number or carrier, and how SIP URI transfer destinations fit in.
- [Numbers & Routing](https://docs.voxworks.ai/routing/overview.md): Route inbound calls and live transfers to the right human at the right location, department, and time of day.
- [Endpoints](https://docs.voxworks.ai/routing/endpoints.md): Addressable transfer destinations that join a location and department and dial a phone, team member, or SIP URI.
- [Transferring Calls to Endpoints](https://docs.voxworks.ai/routing/transferring-calls.md): How a live call actually reaches a human: the ways scripts transfer to routing endpoints, the schedule checks that gate every transfer, fallback behaviour, and the resolution records left behind.
- [Schedules](https://docs.voxworks.ai/routing/schedules.md): Reusable business-hours calendars that decide when a routing endpoint is open.
- [Locations](https://docs.voxworks.ai/routing/locations.md): The physical or logical places your team operates from — address, contact email, timezone and default schedule, edited inline, and how an address is placed on the map for location routing.
- [Location Routing](https://docs.voxworks.ai/routing/location-routing.md): Send callers to the nearest location, or to the location your postcode and locality rules name — Routing settings, the Coverage column, placing locations on the map, and previewing a lookup.
- [Departments](https://docs.voxworks.ai/routing/departments.md): Functional groupings such as Sales, Service, or Bookings that endpoints sit on.
- [Routing Audit Log](https://docs.voxworks.ai/routing/audit-log.md): The resolution records Voxworks writes every time a transfer is attempted — what each field means, how to export them to CSV, and how to debug fallback transfers.
- [Tools](https://docs.voxworks.ai/tools/overview.md): Learn about Tools that execute external integrations like booking appointments, sending SMS messages, and checking availability.
- [Send Webhook](https://docs.voxworks.ai/tools/webhook.md): Call an external HTTP endpoint during a flow and optionally save values from the response into variables.
- [Handoff](https://docs.voxworks.ai/tools/warm-handoff.md): Transfer the caller to a person at one of your routing endpoints, either warm (with a private briefing before the calls are merged) or cold (straight through), and return to the script if nobody answers.
- [Routing | Service Location - v0.2](https://docs.voxworks.ai/tools/service-location-route.md): The composite tool that asks the caller which state and suburb they need service in, confirms the locality, and finds the routing endpoint that covers it, ready for a Handoff step to dial.
- [Auth Check (Caller Identity Verification)](https://docs.voxworks.ai/tools/auth-check.md): Verify a caller's identity by comparing the details they give you against a reference record, with exact or semantic matching and a configurable pass threshold.
- [DTMF Tools](https://docs.voxworks.ai/tools/dtmf.md): Press phone-keypad tones during a call, and read the digits the other party presses into a variable.
- [Jump to Flow/Step](https://docs.voxworks.ai/tools/jump-to-flow-step.md): Send the call to any flow and step chosen while the call is running, then carry on where you left off.
- [Keywords | Set](https://docs.voxworks.ai/tools/keywords-set.md): Replace the call's speech-recognition keyword list part-way through a call, from a comma-separated value.
- [Outbound Opening | Message Check](https://docs.voxworks.ai/tools/outbound-opening-check.md): Hold an outbound call's opening line until whoever answered has spoken, so the steps before the greeting can see who picked up (a person, a voicemail greeting or a call-screening service) and route on it.
- [User Turn | Settled](https://docs.voxworks.ai/tools/user-turn-settled.md): Wait until the caller has finished speaking and their words have been transcribed before the next step speaks or reads the transcript, so the assistant doesn't talk over them.
- [Composite Tools](https://docs.voxworks.ai/tools/composite-tools.md): How composite tools run a complete pre-built conversation inside a single step, and how their inputs, results and outputs connect back to your call — with links to each composite tool's own page.
- [Data Collection - v0.2](https://docs.voxworks.ai/tools/composite/data-collection.md): The standard composite tool for collecting and verifying one data field from a caller by voice — its three collection types (user name, phone number, alphanumeric), inputs, outputs and wiring conventions.
- [Data Collection - Name, Date of Birth, Phone & Alphanumeric](https://docs.voxworks.ai/tools/composite/data-collection-fields.md): Four single-purpose composite tools that each collect and verify one value by voice (a name, a date of birth, a phone number or an alphanumeric reference), with look-back, format checks and attempt limits.
- [SMS | Get Valid Email - v0.1](https://docs.voxworks.ai/tools/composite/sms-get-email.md): The composite tool that collects a validated email address via an SMS round-trip mid-call — how the exchange runs, its inputs and spoken lines, and how the validated email is written back.
- [Arrange Callback | (BETA)](https://docs.voxworks.ai/tools/composite/arrange-callback.md): The composite tool that captures when a caller would like to be called back, confirms the window, and records a structured callback record — including human vs assistant callback modes and how to act on the record.
- [Calendar Booking Overview](https://docs.voxworks.ai/tools/calendar/overview.md): How the calendar booking tools load availability, validate slots, and create appointments across providers.
- [Google Calendar Booking](https://docs.voxworks.ai/tools/calendar/google.md): Create a Google Calendar event after checking free/busy availability.
- [O365 Bookings](https://docs.voxworks.ai/tools/calendar/o365.md): Book an appointment in Microsoft Bookings through Microsoft Graph.
- [Calendly Booking](https://docs.voxworks.ai/tools/calendar/calendly.md): Book an appointment through a Calendly event type.
- [Cal.com Booking](https://docs.voxworks.ai/tools/calendar/calcom.md): Book an appointment through a Cal.com event.
- [GHL Booking](https://docs.voxworks.ai/tools/calendar/ghl.md): Book an appointment in Go High Level.
- [Rex Booking](https://docs.voxworks.ai/tools/calendar/rex.md): Create a Rex calendar event.
- [LLM Tools](https://docs.voxworks.ai/tools/llm/overview.md): Extract structured values from the live conversation using an LLM — a single typed value, or several flat fields in one call.
- [LLM Data](https://docs.voxworks.ai/tools/llm/llm-data.md): Extract a single typed value from the current conversation — a name, email, number, date, appointment time, reference number, or category.
- [LLM Custom](https://docs.voxworks.ai/tools/llm/llm-custom.md): Extract several flat fields from the current conversation in one LLM call, using a supplied JSON schema.
- [Code Step](https://docs.voxworks.ai/tools/code-step/overview.md): Run small, allow-listed Python snippets for routing and variable updates.
- [Variables & Inputs](https://docs.voxworks.ai/tools/code-step/variables-and-inputs.md): Read and write flow variables from a Code Step with double-brace placeholders, and pass extra values in as mapped inputs.
- [Allowed Functions](https://docs.voxworks.ai/tools/code-step/functions.md): The Code Step is deny-by-default. Any function or method not listed here fails validation before execution.
- [Code Step Examples](https://docs.voxworks.ai/tools/code-step/examples.md): Common Code Step patterns — validation, counters, JSON parsing, multi-condition routing — plus troubleshooting.
- [SMS](https://docs.voxworks.ai/tools/sms/overview.md): How the SMS tools text a contact mid-call and read their replies, and the variables each one writes.
- [Send to Contact](https://docs.voxworks.ai/tools/sms/send.md): Send an SMS message to the contact during the conversation.
- [Read from Contact](https://docs.voxworks.ai/tools/sms/read.md): Read the recent SMS exchange with the contact mid-call and write it to a variable you nominate.
- [SMS | Get Value - v0.1](https://docs.voxworks.ai/tools/sms/get-value.md): The composite tool that collects one value by SMS round-trip mid-call (a registration, policy or reference number the caller can type more easily than say), with an optional format check.
- [Integrations Overview](https://docs.voxworks.ai/integrations/overview.md): Connect external services to your voice assistant through integrations.
- [Connecting Google Calendar](https://docs.voxworks.ai/integrations/google.md): How to connect Google Calendar to Voxworks with OAuth, what the connection can access, connection statuses, reauthorisation, and the dedicated Voxworks calendar.
- [Connecting Microsoft 365 & Bookings](https://docs.voxworks.ai/integrations/microsoft.md): Connect Microsoft 365 and Microsoft Bookings to Voxworks — the OAuth sign-in, the tenant admin-consent approval flow with automatic status checking, choosing a Bookings business, and what happens when you disconnect.
- [Connecting Calendly](https://docs.voxworks.ai/integrations/calendly.md): Create a Calendly Personal Access Token and connect it to Voxworks so your voice agents can book appointments into your Calendly event types.
- [Connecting Cal.com](https://docs.voxworks.ai/integrations/calcom.md): Generate a Cal.com API key and connect it to Voxworks so your voice agents can book appointments into your Cal.com event types.
- [Connecting GoHighLevel](https://docs.voxworks.ai/integrations/ghl.md): Connect your GoHighLevel (GHL) account to Voxworks with an API key, and understand the team default GHL calendar the booking tool falls back to.
- [Connecting Rex](https://docs.voxworks.ai/integrations/rex.md): Connect your Rex CRM account to Voxworks with your Rex login so your voice agents can book appointments into Rex calendars, and import Rex properties, agents and contacts.
- [Connecting Agentbox](https://docs.voxworks.ai/integrations/agentbox.md): Connect Agentbox CRM with your API key and Client ID, choose which properties, agents and contacts to import, run the initial import, turn imported contacts into callable contact records, and keep everything current with the daily sync.
- [Monday.com Integration](https://docs.voxworks.ai/integrations/monday.md): Trigger Voxworks calls from a Monday.com board and write call results back onto the board item, using an API key connection and the Automations pipeline.
- [Zapier, Make & n8n](https://docs.voxworks.ai/integrations/zapier-make-n8n.md): Connect Voxworks to Zapier, Make, or n8n using inbound webhook triggers, the Send Webhook tool and automation Webhook destinations, and the REST API.
- [Automations](https://docs.voxworks.ai/automations/overview.md): Automations connect your voice calls to the rest of your business. Trigger outbound calls from CRM events, sync call results back to your CRM, send notifications, and build end-to-end workflows — all without writing code.
- [Triggers](https://docs.voxworks.ai/automations/triggers.md): Triggers are the events that start an automation pipeline. Choose from inbound webhooks, call events, integration events, or a recurring schedule to kick off your workflows.
- [Notification Triggers & System Automations](https://docs.voxworks.ai/automations/notification-triggers.md): Run automations when app notifications fire, use the notification context in your steps, and manage the built-in Emergency SMS and email alert automations.
- [Steps](https://docs.voxworks.ai/automations/steps.md): Steps are the building blocks of an automation pipeline. Each step performs a specific action — transforming data, creating contacts, placing calls, syncing to CRMs, or sending notifications.
- [Conditions](https://docs.voxworks.ai/automations/conditions.md): Use conditions to branch your automation pipeline based on call outcomes, contact data, or any field in the context. Route different results down different paths — send alerts for failures, escalate low ratings, or skip steps when data is missing.
- [Field Mapping & Context](https://docs.voxworks.ai/automations/field-mapping.md): Understand how data flows through an automation pipeline using the shared context object and field mappings with dot-notation paths.
- [Call-Start Data Sourcing](https://docs.voxworks.ai/automations/call-start-data.md): Fetch live data from your CRM or external APIs at the exact moment a call begins, so your voice assistant always has the most up-to-date context.
- [Execution Log & Monitoring](https://docs.voxworks.ai/automations/execution-log.md): Track, debug, and monitor your automation runs using the execution log. See per-step results, errors, timing, and data flow for every automation execution.
- [Pipeline Guides](https://docs.voxworks.ai/automations/pipeline-guides.md): Step-by-step walkthroughs for building common automation pipelines: CRM-triggered outbound calls, post-call CRM sync, email follow-ups, conditional notifications, and webhook integrations.
- [Example Pipelines](https://docs.voxworks.ai/automations/examples.md): Ready-to-use automation pipeline examples for common business scenarios: appointment reminders, lead qualification, payment follow-ups, customer surveys, real estate callbacks, and more.
- [HubSpot Call Sync](https://docs.voxworks.ai/automations/hubspot-call-sync.md): Automatically log every completed Voxworks call in HubSpot CRM — with the summary, outcome, duration, and phone numbers — using a Call Completed automation.
- [Custom Variables Overview](https://docs.voxworks.ai/custom-variables/overview.md): What custom variables are, how they differ from contact fields, and a tour of the Custom Variables workspace — type tabs, saved views, add forms, the detail pane, field propagation, hierarchy and deletion.
- [Custom Variable Types & Schema Validation](https://docs.voxworks.ai/custom-variables/types.md): Design your own custom variable types with a field-by-field schema builder, choose how strictly incoming data is validated, and install ready-made types from the catalogue.
- [Linking Custom Variables to Contacts](https://docs.voxworks.ai/custom-variables/linking-contacts.md): How to attach custom variable records to contacts — one by one, in bulk, by CSV, or through the API and automations — and what your voice agent reads on a call as a result.
- [Importing Custom Variables from CSV](https://docs.voxworks.ai/custom-variables/csv-import.md): Create typed custom variable records in bulk from a spreadsheet — the custom.{type}.{field} header convention, column mapping, type conversion rules, and where typed CSV import appears across the app.
- [Signing Up, Signing In & Password Recovery](https://docs.voxworks.ai/account/sign-in.md): How to create a Voxworks account, sign in with a password, magic link or Google, and recover access if you forget your password.
- [Your Profile & Personal Settings](https://docs.voxworks.ai/account/profile.md): Manage your name, photo, mobile number, password, multi-factor authentication and language from your Personal Settings — and why your mobile number matters beyond sign-in.
- [Multi-Factor Authentication](https://docs.voxworks.ai/account/mfa.md): How to add an authenticator-app factor to your sign-in, what happens at the /auth/verify challenge, how mobile-number SMS verification works, and how email codes protect destructive actions.
- [Personal vs Team Accounts](https://docs.voxworks.ai/account/personal-vs-team.md): How your personal account differs from a team, why every feature you use lives inside a team, and how to switch between or create multiple teams.
- [Deleting an Account or Team](https://docs.voxworks.ai/account/deletion.md): How to permanently delete a team or your personal account, the email verification step that protects both flows, and what happens to your data, numbers and wallet balance.
- [Inviting & Managing Members](https://docs.voxworks.ai/team/members.md): How to invite people to a team, manage pending invitations, accept an invite as a new user, change roles, remove members, leave a team, and transfer ownership.
- [Roles & Permissions](https://docs.voxworks.ai/team/roles-permissions.md): How the Owner, Admin, and Member roles work in a Voxworks team, what the primary owner controls, how ownership transfers, and which permission every gated action checks.
- [Team Settings & Notifications](https://docs.voxworks.ai/team/settings.md): The General, Notifications and Danger Zone areas of a team's Settings — team logo, name, UUID, phone number and timezone, muting non-critical notifications, escalation automations, and how to leave or delete a team.
- [Email Templates](https://docs.voxworks.ai/team/email-templates.md): Build reusable email designs for your team — start from a Voxworks system template or design your own, insert call and contact variables, set a team default, and use the templates in automation Email steps.
- [Plans, Tiers & Feature Gates](https://docs.voxworks.ai/billing/plans.md): The Voxworks subscription tiers — included minutes, overage rates, call concurrency, team size and the features each plan unlocks — plus what happens when an account has no active plan.
- [How Call Billing Works](https://docs.voxworks.ai/billing/how-billing-works.md): How Voxworks calculates the cost of a call, the order in which credits and your wallet are charged, and what happens when your balance runs low.
- [Managing Your Subscription](https://docs.voxworks.ai/billing/subscription.md): Change your subscription plan, understand how trial deferral and proration affect what you're charged, and cancel or reactivate your plan from Settings > Billing.
- [Wallet & Top-Ups](https://docs.voxworks.ai/billing/wallet.md): What your Voxworks wallet pays for, topping it up manually with GST, 1-click versus card-entry payments, and what a negative balance means.
- [Payment Methods & Invoices](https://docs.voxworks.ai/billing/payment-methods.md): Add and manage the cards Voxworks bills, set your billing address and ABN, and download or view past invoices.
- [Usage History](https://docs.voxworks.ai/billing/usage.md): How to read your Wallet Usage and Minute Usage ledgers, how a call's time is split between the AI assistant, your team and the system, filtering by billing period, and exporting usage as CSV.
- [Security & Compliance Overview](https://docs.voxworks.ai/security/overview.md): How Voxworks protects your data — Australian data residency, encryption in transit and at rest, recording storage security, team-based access control, and hardening against SSRF and prompt injection — written for vendor security assessments.
- [Call Recording & Consent](https://docs.voxworks.ai/security/recording-consent.md): What Voxworks records, what you're responsible for disclosing and obtaining consent for, how disclosure is tracked per call, and how recording access is controlled, logged and delivered through the API.
- [DNCR & Opt-Out Compliance](https://docs.voxworks.ai/security/dncr-compliance.md): How Voxworks screens outbound batch calls against Australia's Do Not Call Register and your own opt-out list, how the override and audit trail work, and where legal responsibility sits.
- [Data Retention & Deletion](https://docs.voxworks.ai/security/data-retention.md): How long Voxworks keeps different kinds of account data, how to export it before it ages out, and how to raise a privacy complaint.
- [Call Review & External Sharing](https://docs.voxworks.ai/security/call-review.md): How to share a call outside your Voxworks workspace today, and what's coming for granting a reviewer temporary, revocable access to a single call.
- [Surveys](https://docs.voxworks.ai/surveys/overview.md): What the Surveys module does, who can use it, and how a survey moves from a draft questionnaire to a compiled call script, live calls and results.
- [Surveys list](https://docs.voxworks.ai/surveys/surveys-list.md): The Surveys page: finding a survey with the filters and search, reading the table columns, starting a new survey, and copying or archiving an existing one.
- [Create a survey](https://docs.voxworks.ai/surveys/create-a-survey.md): Start a new survey from scratch with the Start a new survey dialog, see what it creates, and follow a walkthrough from an empty draft to a first published survey.
- [Survey workspace](https://docs.voxworks.ai/surveys/survey-workspace.md): The page a survey opens on: the header and version chip, the Setup and Results modes and their tabs, the toolbar buttons, the banners you may see, and when a version can be edited.
- [Questions tab](https://docs.voxworks.ai/surveys/questions-tab.md): The Setup → Questions tab: the Outline of fixed and authored sections, adding, moving and deleting sections and questions, the inspector pane, and the Routing card under each question.
- [Sections](https://docs.voxworks.ai/surveys/sections.md): How authored sections group a survey's questions: the section title and intro line, section keys, ordering, and how the first section's title stands in for the study name.
- [Question settings](https://docs.voxworks.ai/surveys/question-settings.md): The settings every survey question shares — title, type, key, voice prompt and piping, alternative phrasings, the Voice panel and the Behaviour panel — what the interviewer does with each answer, and the variables every question records.
- [Answer confirmation](https://docs.voxworks.ai/surveys/answer-confirmation.md): When the survey interviewer reads an answer back before recording it: the Read every answer back switch, the automatic did-you-say check on possible mishearings, the default for each question type, and how respondents' replies to a check are handled.
- [Attempts and step levels](https://docs.voxworks.ai/surveys/attempts-and-step-levels.md): How many times the survey interviewer re-asks, reads back, clarifies and nudges before moving on, and how quickly it takes turns: the survey-wide floor in the Agent section, per-question overrides, each attempt cap, the Eagerness, Idle and Thinking levels, and the FAQ and behaviour sets.
- [Survey Variables and Piping](https://docs.voxworks.ai/surveys/survey-variables.md): Carry values through a survey: the Variables card, the Set variable action, piping earlier answers, variables and contact fields into prompts, the readiness checks on piped tokens, and every custom variable a survey call writes.
- [Avoiding Repetition](https://docs.voxworks.ai/surveys/repetition.md): How a survey keeps the interviewer from sounding like a recording: alternative phrasings on questions, longer forms on battery items, greeting variants, varied options lead-ins, what re-asks sound like, and the moving-on line.
- [Answers Given Early and Interruptions](https://docs.voxworks.ai/surveys/riders-and-interruptions.md): How the survey interviewer decides whether a reply is an answer to the current question or a request — an FAQ, busy or stop — and what happens when a respondent answers before being asked, asks what a word means, asks for the options again, or talks over the question.
- [Display](https://docs.voxworks.ai/surveys/question-types/display.md): The Display question type: a statement the interviewer reads out with no answer — for introductions, transitions and notices — its settings, what the respondent hears, and why it records nothing.
- [Single choice](https://docs.voxworks.ai/surveys/question-types/single-choice.md): The Single choice question type: one answer from a list. Covers answer options and keys, Read out and Volunteered only options, Keep position, Accept / Often heard as / Reject, the options lead-in, shuffling, answer mode, confirmation, don't-know and refusals, and what is recorded.
- [Rating](https://docs.voxworks.ai/surveys/question-types/rating.md): The Rating question type: a scale whose points are its answer options. How it relates to Single choice, how to author word and number scales, when to use Number or Battery instead, and what is recorded.
- [Battery (grid)](https://docs.voxworks.ai/surveys/question-types/battery.md): Battery questions: several items asked one at a time against the same scale. Covers turning Battery on, items and their keys, longer forms for re-asks, the decline caps, item shuffling, what the respondent hears, and how each item's answer is recorded.
- [Number](https://docs.voxworks.ai/surveys/question-types/number.md): The Number question type: a spoken number such as a postcode, age, count or 0–10 score. Covers the Format check (pattern or range), Screen out, Format hint, confirmation, what the respondent hears, and what is recorded.
- [Long text](https://docs.voxworks.ai/surveys/question-types/long-text.md): The Long text question type: an open answer in the respondent's own words. Covers the one-time probe and probe lines, summary read-back, don't-know and refusal handling, recommended timing, and what is recorded.
- [First name](https://docs.voxworks.ai/surveys/question-types/first-name.md): The First name question type: collecting or confirming the respondent's first name. Covers the Collect settings, confirming a name you already hold, spelling back, look back, what the respondent hears, and what is recorded.
- [Phone number](https://docs.voxworks.ai/surveys/question-types/phone-number.md): The Phone number question type: collecting or confirming an Australian phone number. Covers the Collect settings, the fixed Australian formats, E.164 storage, why the read-back is the only check, what the respondent hears, and what is recorded.
- [Agent Section](https://docs.voxworks.ai/surveys/agent.md): The Agent fixed section of a survey: who is calling, the voice, persona and tone, the maximum call duration, call-wide keyterms, the moving-on line, and the attempt caps and step levels every question inherits.
- [Gatekeeper](https://docs.voxworks.ai/surveys/gatekeeper.md): The Gatekeeper fixed section opens every survey call: the greeting and consent question, the opening line, the named opening, screeners and receptionists, holds, callbacks, wrong numbers and the inbound introduction. Every Outbound and Inbound field, and what the respondent hears.
- [Voicemail and SMS](https://docs.voxworks.ai/surveys/voicemail.md): What a survey call does when an answering machine picks up: how machines are detected, the spoken message, SMS and hang-up options on the Gatekeeper's Outbound pane, and how voicemail is recorded.
- [FAQs](https://docs.voxworks.ai/surveys/faqs.md): The FAQs fixed section: answers to what respondents ask during a survey call. Each FAQ's fields, the 41–99 priority band, the catch-all, asked-again lines, Always fires, the FAQ step levels, and a starter set including 'are you an AI?'.
- [Behaviours (Busy and Stop)](https://docs.voxworks.ai/surveys/behaviours.md): The Behaviours fixed section: the busy and stop routes that end a survey part-way through, what counts as each, their outcomes and priorities, why Always fires is normally left off, and the behaviour step levels.
- [Closing and Outcomes](https://docs.voxworks.ai/surveys/closing-and-outcomes.md): The Closing fixed section: the farewell, the outcome codes a survey call can end with, the closing text spoken for each, the four codes the survey shell always uses, the missing-code alert, and how outcomes map to session statuses in Results.
- [Logic Tab and Canvas](https://docs.voxworks.ai/surveys/logic.md): The Setup → Logic tab: the routing canvas and its nodes, drawing a rule by dragging, the Routing rules list, rules outside the flow, the question view with rules leaving and arriving, and the Variables card.
- [Routing Rules](https://docs.voxworks.ai/surveys/routing-rules.md): Write survey routing rules in the simple and advanced editors: triggers, conditions and operators, call facts, every action from jumps and show/hide to option and battery-item masking, Set variable and early endings, plus priority and the validation messages.
- [Readiness](https://docs.voxworks.ai/surveys/readiness.md): The Setup → Readiness tab: the Voice readiness panel, the Findings and Validation target cards, every blocker that stops a survey compiling or publishing, every warning, and how to fix each one.
- [Validate, Compile and Publish](https://docs.voxworks.ai/surveys/validate-compile-publish.md): How a survey becomes a runnable call script: the Validate, Compile and Publish buttons, who can use them, the job labels while they run, script version numbers, how compiled drafts relate to test calls and live calls, and what to do when a compile or publish fails.
- [Versions and Drafts](https://docs.voxworks.ai/surveys/versions.md): How survey versions work: version statuses, the version chip, the Version history page, creating a draft from a published version, why published and imported versions are read-only, Voxworks copies, archiving, and the guards that stop you deleting content that is in use.
- [Settings Tab](https://docs.voxworks.ai/surveys/settings-tab.md): The Setup → Settings tab of a survey: the name and description, the source provenance of imported surveys, and the compiled identity — the Call Script and flows the survey compiles into, with a link to the script.
- [Running a Survey](https://docs.voxworks.ai/surveys/running-a-survey.md): How a published survey makes and takes calls: the compiled Call Script named after the survey, choosing a voice, test calling a draft, dialling respondents from Batch Scheduler, answering inbound calls on a number, and what to check before launch.
- [Importing Surveys](https://docs.voxworks.ai/surveys/import.md): Import a survey from a Voxworks JSON survey definition: the Import from platform wizard, Upload new version, the JSON format and the question types it maps, file limits and error messages, and working with read-only imported surveys.
- [Survey Jobs](https://docs.voxworks.ai/surveys/jobs.md): The Survey jobs page: the background work behind imports, compiles and publishes across your account — its filters, columns and statuses, and where to look when a job fails.
- [Results](https://docs.voxworks.ai/surveys/results.md): Read a survey's results in the workspace's Results mode: the filters, the Overview metric cards, sessions over time, terminal statuses, the contact funnel, largest drop-offs and data quality, and the Questions, Outcomes and Routes views.
- [Responses and Export](https://docs.voxworks.ai/surveys/responses-and-export.md): Browse individual survey responses, open a response to see its answers, call record and session variables, and download the filtered answers as a CSV — with the file's columns and the permissions that apply.
- [MCP Connector Overview](https://docs.voxworks.ai/mcp/overview.md): Connect an outside AI assistant such as Claude to your Voxworks team, and what it can do for you once it is connected.
- [Connecting an Assistant](https://docs.voxworks.ai/mcp/connecting.md): Add the Voxworks MCP server to Claude or another MCP-capable assistant, then approve the connection on the Voxworks authorisation screen.
- [Permissions](https://docs.voxworks.ai/mcp/permissions.md): Each permission on the Voxworks authorisation screen, what it lets a connected assistant do, and how it combines with your own team role.
- [Managing Connected Apps](https://docs.voxworks.ai/mcp/managing-connections.md): See which assistants are connected to your account under Settings > MCP Clients, and revoke one to cut off its access.
- [Working on Scripts](https://docs.voxworks.ai/mcp/scripts.md): Ask a connected assistant to explain, review, edit, copy, roll back or write a Voxworks call script, and how its changes are checked and versioned.
- [Recommendations](https://docs.voxworks.ai/mcp/recommendations.md): Work through a script's AI recommendations with a connected assistant: apply, reject or undo them, file new suggestions and ask for a fresh review.
- [Building Surveys](https://docs.voxworks.ai/mcp/surveys.md): Turn a questionnaire in Word, PDF or text into a Voxworks survey draft with a connected assistant, check it, and follow its test compile.
- [Calls & Operations](https://docs.voxworks.ai/mcp/calls-and-operations.md): Ask a connected assistant why a call failed, what was said, why a batch stalled, whether an automation ran, which script answers a number and how much you've used.
- [Built-in Guidance](https://docs.voxworks.ai/mcp/built-in-guidance.md): The guides and reference material the Voxworks MCP connector gives an assistant, so it follows Voxworks' own methods without anything to install.
- [Tools Reference](https://docs.voxworks.ai/mcp/tools-reference.md): Every tool the Voxworks MCP connector offers a connected assistant, grouped by area, with the permission each one needs.
- [API Overview](https://docs.voxworks.ai/api-reference/overview.md): Authenticate, send requests, handle errors, and use the Voxworks public API reference.
- [API Keys & Authentication](https://docs.voxworks.ai/api-reference/authentication.md): Generate, use, and manage the API keys that authenticate requests to the Voxworks API, plus the exact error responses to expect.
- [API Quickstart](https://docs.voxworks.ai/api-reference/quickstart.md): Generate an API key, create a contact, schedule a call, poll its status, and fetch the finished result — a complete first request against the Voxworks API.
- [Embedded Web Calls](https://docs.voxworks.ai/api-reference/embedded-web-calls.md): Put a Voxworks agent on your own website — mint a single-use session on your server, connect the visitor's browser to the media edge, and run the same script, tools and handoffs as a phone call.
- [Rate Limits & Request Limits](https://docs.voxworks.ai/api-reference/rate-limits.md): Every rate-limit bucket the Voxworks API enforces, how the sliding window works, the headers a 429 returns, and the request-size and list-pagination caps.
- [Receiving Webhooks from Voxworks](https://docs.voxworks.ai/api-reference/receiving-webhooks.md): How to build an endpoint that receives outbound webhook deliveries from a Voxworks automation — payload shape, headers, retry behaviour, and the URL requirements your endpoint must meet.
- [Health check](https://docs.voxworks.ai/api-reference/health/health-check.md): Returns API service health. This endpoint does not require authentication.
- [Create contact](https://docs.voxworks.ai/api-reference/contacts/create-contact.md): Create a new contact for your team. The request fails if a contact with the same normalized phone number already exists.
- [Get contact by phone number](https://docs.voxworks.ai/api-reference/contacts/get-contact-by-phone-number.md): Retrieve a contact by phone number for your team. If using a leading plus sign, URL-encode it as `%2B`.
- [Create phone call](https://docs.voxworks.ai/api-reference/calls/create-phone-call.md): Create and schedule an outbound phone call. Contact details are upserted by phone number and optional object data is validated and linked.
- [Create web session](https://docs.voxworks.ai/api-reference/calls/create-web-session.md): Mint a single-use session for a browser call placed from a page you host. Returns a short-lived token plus the SIP bootstrap the browser needs to reach the Voxworks media edge directly; audio never passes through this API.
- [List calls](https://docs.voxworks.ai/api-reference/calls/list-calls.md): List calls for your team with optional filters and cursor pagination.
- [Get call](https://docs.voxworks.ai/api-reference/calls/get-call.md): Retrieve a call by ID. Only calls belonging to your team are returned.
- [Get call status](https://docs.voxworks.ai/api-reference/calls/get-call-status.md): Retrieve lightweight lifecycle fields for a call.
- [Get call result](https://docs.voxworks.ai/api-reference/calls/get-call-result.md): Retrieve post-call result fields including summary, transcript, recording URL, structured data, rating, and objectives.
- [Cancel call](https://docs.voxworks.ai/api-reference/calls/cancel-call.md): Cancel a call that is still scheduled.
- [Reschedule call](https://docs.voxworks.ai/api-reference/calls/reschedule-call.md): Reschedule a call that is still scheduled. `PUT` is also accepted by the API.
- [Retry call](https://docs.voxworks.ai/api-reference/calls/retry-call.md): Create a new scheduled phone call from a prior retryable call. Web calls cannot be retried with this endpoint.
- [List lists](https://docs.voxworks.ai/api-reference/lists/list-lists.md): List contact lists for your team. Pass `with_counts=true` to include each list's `contact_count`.
- [Create list](https://docs.voxworks.ai/api-reference/lists/create-list.md): Create a new contact list.
- [Get list](https://docs.voxworks.ai/api-reference/lists/get-list.md): Get a list and its contacts.
- [Edit list](https://docs.voxworks.ai/api-reference/lists/edit-list.md): Rename a list. `PUT` to the same path is also accepted and behaves the same way.
- [Delete list](https://docs.voxworks.ai/api-reference/lists/delete-list.md): Soft-delete a list. The contacts in it are not deleted.
- [Add existing contacts to list](https://docs.voxworks.ai/api-reference/lists/add-existing-contacts-to-list.md): Add contacts that already exist in your team to a list, by contact ID. Send `contact_ids` (up to 500) or a single `contact_id`. Contacts already in the list are counted in `alreadyInListCount` and not added twice. If any ID does not belong to your team the request returns 404 with `missing_contact_i…
- [Create or add contacts to list](https://docs.voxworks.ai/api-reference/lists/create-or-add-contacts-to-list.md): Create or reuse contacts by phone number and add them to a list. Send `contacts` (up to 500) or a single `contact` object. A phone number that already belongs to one of your contacts reuses that contact. Contacts added this way reach any active batch that uses the list through the batch's own intake…
- [Remove contacts from list](https://docs.voxworks.ai/api-reference/lists/remove-contacts-from-list.md): Remove contacts from a list, by contact ID (`contact_ids` / `contact_id`) or by list-contact row ID (`list_contact_ids` / `list_contact_id`), up to 500 per request. The contacts themselves are not deleted. With neither in the body the request returns 400.
- [List object types](https://docs.voxworks.ai/api-reference/objects/list-object-types.md)
- [Create object type](https://docs.voxworks.ai/api-reference/objects/create-object-type.md): Create an object type for your team. The legacy `/api/v1/create-object-type` route is also accepted.
- [Get object type by ID](https://docs.voxworks.ai/api-reference/objects/get-object-type-by-id.md)
- [Get object type by name](https://docs.voxworks.ai/api-reference/objects/get-object-type-by-name.md)
- [Create object](https://docs.voxworks.ai/api-reference/objects/create-object.md)
- [Upsert object](https://docs.voxworks.ai/api-reference/objects/upsert-object.md): Create or update an object using a JSON data key. If `upsert_key` is omitted, the API tries `$.external_ids.rex.property_id` and then `$.id`.
- [Delete object](https://docs.voxworks.ai/api-reference/objects/delete-object.md): Soft-delete an object.
- [Link contact to object](https://docs.voxworks.ai/api-reference/objects/link-contact-to-object.md): Link an existing contact to an object. The alias `/api/v1/link-object-to-contact/{object_id}` is also accepted.
- [Trigger automation webhook](https://docs.voxworks.ai/api-reference/webhooks/trigger-automation-webhook.md): Receive an inbound webhook POST and enqueue an automation execution. This endpoint uses a webhook token in the path instead of bearer API-key authentication.
- [Product Updates](https://docs.voxworks.ai/updates/overview.md): A weekly record of what's new and improved in Voxworks.
- [Week of 21 September 2026](https://docs.voxworks.ai/updates/2026-09-21.md): Uninterruptible turns, Allow skip and a Verbatim threshold for steps, a Not Connected call status, Direction for test scenarios, and recommendations that can remove a step.
- [Week of 14 September 2026](https://docs.voxworks.ai/updates/2026-09-14.md): Route callers to their nearest location, choose what happens when an endpoint is closed, precise end reasons, and a visual automation canvas.
- [Week of 7 September 2026](https://docs.voxworks.ai/updates/2026-09-07.md): Batches now dial whenever a line is free, steps gain a Fast Response setting, and post-call analysis can fill in caller names and raise follow-ups.
- [Week of 31 August 2026](https://docs.voxworks.ai/updates/2026-08-31.md): Surveys arrives in beta, scheduled calls can be cancelled from the Call Log, a new SMS Get Value tool, and cold transfers that ring and recover.
- [Week of 24 August 2026](https://docs.voxworks.ai/updates/2026-08-24.md): A new script Overview tab and five-tab editor, per-step AI models, a media player docked on every page, live listening and take-over, and a template browser for new scripts.
- [Week of 17 August 2026](https://docs.voxworks.ai/updates/2026-08-17.md): Scripts can switch language mid-call, classifiers can be shared across a script, steps can be made uninterruptible, and Key Terms gain Overfit.
- [Week of 10 August 2026](https://docs.voxworks.ai/updates/2026-08-10.md): Test Console Scenarios and call replays, lists that fill themselves from a rule, the Agentbox integration and reusable email templates.
- [Week of 4 August 2026](https://docs.voxworks.ai/updates/2026-08-04.md): The Test Console arrives, batch retries become a visual timeline, and the Calls list gains Trunk, Outcome and Sentiment filters.
- [Week of 28 July 2026](https://docs.voxworks.ai/updates/2026-07-28.md): A rebuilt Dashboard with PDF export, AI script recommendations as a review workflow, voicemail modes and background classifiers.
- [Week of 21 July 2026](https://docs.voxworks.ai/updates/2026-07-21.md): Call details rebuilt around the transcript, live call controls, and Warm and Cold transfer modes for Live Handoff.
- [Week of 14 July 2026](https://docs.voxworks.ai/updates/2026-07-14.md): Automations gain a Schedule trigger and a Code step, and you can connect external AI applications to your scripts.

## OpenAPI Specs

- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.