# Voxworks

## Docs

- [Cancel call](https://docs.voxworks.ai/api-reference/calls/cancel-call.md): Cancel a call that is still scheduled.
- [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 call](https://docs.voxworks.ai/api-reference/calls/create-web-call.md): Create an in-browser web call and return SIP WebRTC details for a browser softphone.
- [End web call](https://docs.voxworks.ai/api-reference/calls/end-web-call.md): Mark an active web call as ended if the browser or SIP path cannot reliably update disconnect state.
- [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 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.
- [Get call status](https://docs.voxworks.ai/api-reference/calls/get-call-status.md): Retrieve lightweight lifecycle fields for a call.
- [List calls](https://docs.voxworks.ai/api-reference/calls/list-calls.md): List calls for your team with optional filters and cursor pagination.
- [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.
- [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`.
- [Health check](https://docs.voxworks.ai/api-reference/health/health-check.md): Returns API service health. This endpoint does not require authentication.
- [Add existing contacts to list](https://docs.voxworks.ai/api-reference/lists/add-existing-contacts-to-list.md): Add existing contacts to a list by contact IDs. The singular route `/add-existing-contact-to-list/{list_id}` is also accepted.
- [Create list](https://docs.voxworks.ai/api-reference/lists/create-list.md): Create a new contact list.
- [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. The singular route `/add-contact-to-list/{list_id}` is also accepted.
- [Delete list](https://docs.voxworks.ai/api-reference/lists/delete-list.md): Soft-delete a list.
- [Edit list](https://docs.voxworks.ai/api-reference/lists/edit-list.md): Rename a list. `PUT` is also accepted by the API.
- [Get list](https://docs.voxworks.ai/api-reference/lists/get-list.md): Get a list and its contacts.
- [List lists](https://docs.voxworks.ai/api-reference/lists/list-lists.md): List contact lists for your team.
- [Remove contacts from list](https://docs.voxworks.ai/api-reference/lists/remove-contacts-from-list.md): Remove contacts from a list by contact IDs or list-contact row IDs. The singular route `/delete-contact-from-list/{list_id}` is also accepted.
- [Create object](https://docs.voxworks.ai/api-reference/objects/create-object.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.
- [Delete object](https://docs.voxworks.ai/api-reference/objects/delete-object.md): Soft-delete an object.
- [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)
- [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.
- [List object types](https://docs.voxworks.ai/api-reference/objects/list-object-types.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`.
- [API Overview](https://docs.voxworks.ai/api-reference/overview.md): Authenticate, send requests, handle errors, and use the Voxworks public API reference.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [Triggers](https://docs.voxworks.ai/automations/triggers.md): Triggers are the events that start an automation pipeline. Choose from inbound webhooks, call events, or integration events to kick off your workflows.
- [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.
- [Keywords](https://docs.voxworks.ai/conversation-dynamics/keywords.md): Keywords improve transcription accuracy for specific terms that are important to your script. This is particularly useful for brand names, industry jargon, or uncommon words that the transcription service might otherwise mishear.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [Flow Steps](https://docs.voxworks.ai/flows/steps-flow.md): Flow Steps navigate to sub-flows, enabling modular and reusable conversation designs.
- [Function Steps](https://docs.voxworks.ai/flows/steps-function.md): Function Steps execute custom logic during your conversation — validating data, performing calculations, and making decisions that LLMs aren't suited for.
- [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.
- [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.
- [Variables](https://docs.voxworks.ai/flows/variables.md): Variables store and pass data throughout your conversations. They enable dynamic scripts and personalised interactions.
- [Contact Email is Available](https://docs.voxworks.ai/functions/email/contact-email-is-available.md): Check if the contact has an email address on record before attempting to send communications.
- [Functions](https://docs.voxworks.ai/functions/overview.md): Functions execute custom logic during conversations like validating data, performing calculations, and making decisions that LLMs aren't suited for.
- [Contact Phone is SMS Capable](https://docs.voxworks.ai/functions/phone/contact-phone-is-sms-capable.md): Check if the contact's phone number can receive SMS messages (i.e. is a mobile number).
- [Getting Started](https://docs.voxworks.ai/index.md): Learn about Voxworks, the enterprise platform for building AI voice assistants that automate customer conversations.
- [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.
- [Data Collection](https://docs.voxworks.ai/scripts/data-collection.md): Learn about data collection features in Voxworks voice assistants.
- [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 provides your assistant with factual reference information to draw from during conversations. Use it for specific data like pricing, features, availability, and prepared responses to common questions.
- [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.
- [Settings](https://docs.voxworks.ai/scripts/settings.md): Script Settings configure operational parameters for your voice assistant, including voice selection, transcription accuracy, and call duration limits.
- [Voicemail Message](https://docs.voxworks.ai/scripts/voicemail-message.md): The Voicemail Message defines what your assistant says when it detects a voicemail system during an outbound call. This ensures you leave a professional message even when the contact doesn't answer.
- [Calendar - Check Availability](https://docs.voxworks.ai/tools/calendar/calendar-availability.md): Select and format availability slots for users based on their preferences from Calendly data.
- [Get Availabilities](https://docs.voxworks.ai/tools/integrations/calendly/calendly-availability.md): Get available time slots from a Calendly calendar for appointment booking.
- [Book Time](https://docs.voxworks.ai/tools/integrations/calendly/calendly-booking.md): Book an appointment in a Calendly calendar based on user selection.
- [Cancel Booking](https://docs.voxworks.ai/tools/integrations/calendly/calendly-cancel.md): Cancel an existing Calendly booking during a conversation.
- [Calendly](https://docs.voxworks.ai/tools/integrations/calendly/overview.md): Connect your Calendly account to enable appointment booking, availability checking, and cancellation through your voice assistant.
- [O365 Bookings](https://docs.voxworks.ai/tools/integrations/o365-bookings/overview.md): Complete O365 Bookings flow with availability, booking, SMS confirmation, and cancellation through your voice assistant.
- [Integrations Overview](https://docs.voxworks.ai/tools/integrations/overview.md): Connect external services to your voice assistant through integrations.
- [SMS](https://docs.voxworks.ai/tools/integrations/sms/overview.md)
- [Read and Extract Email](https://docs.voxworks.ai/tools/integrations/sms/sms-read-email.md): Receive an SMS from the contact and extract an email address from it.
- [Send to Contact](https://docs.voxworks.ai/tools/integrations/sms/sms-send.md): Send an SMS message to the contact during the conversation.
- [Tools](https://docs.voxworks.ai/tools/overview.md): Learn about Tools that execute external integrations like booking appointments, sending SMS messages, and checking availability.

## OpenAPI Specs

- [openapi](https://docs.voxworks.ai/openapi.yaml)