# VINSI.AI Documentation

> VINSI.AI is a business communications platform: AI phone agents (inbound, outbound, batch calling), a business phone system (softphone, desk phones, hunt groups, call queues, voicemail, fax), a CRM, a ticket system, QA call scoring, and VINSI Meet video meetings.

Guidance for AI assistants:
- Dashboard (where users click): https://dashboard.vinsi.ai. Video meetings: https://meet.vinsi.ai. Docs: https://docs.vinsi.ai.
- REST API base URL: https://dashboard.vinsi.ai. Authenticate every request with the header `x-api-key: <key>`. Admins create keys in Settings → API Keys (shown once).
- Machine-readable API spec: https://docs.vinsi.ai/openapi.json
- Every page below is available as Markdown by adding .md to its path. All pages in one file: https://docs.vinsi.ai/llms-full.txt
- Most features are configured in the dashboard UI; the guides give exact menu paths, button labels, and field names. Only the endpoints in the API Reference section are available to API keys.

## Overview

- [Get to know the VINSI products](https://docs.vinsi.ai/vinsi-products.md): An overview of all VINSI products and what each one does

## Getting Started

- [Your First Phone Agent](https://docs.vinsi.ai/getting-started/first-phone-agent.md): Learn how to create and configure your first AI phone agent from scratch
- [How to Use the Dashboard](https://docs.vinsi.ai/getting-started/howto-use-dashboard.md): Use the AI agent dashboard: overview metrics, geographic and agent performance analytics, filters, and reports
- [Using VINSI with AI Assistants](https://docs.vinsi.ai/getting-started/ai-assistants.md): llms.txt, Markdown pages, and the OpenAPI spec so Claude, ChatGPT, Gemini, and coding agents can use these docs and the API

## Step-By-Step Guides

- [Setting up an email campaign](https://docs.vinsi.ai/step-guides/email-campaign.md): Learn how to create an email campaign from scratch
- [Running a batch call campaign](https://docs.vinsi.ai/step-guides/batch-call.md): Step-by-step guide to launching an AI-powered batch calling campaign

## Organizations

- [Manage Organization](https://docs.vinsi.ai/organization/manageOrganization.md): Organization settings, members, custom roles and permissions, and transferring ownership
- [Permission Groups](https://docs.vinsi.ai/organization/permissionGroups.md): Create roles like Supervisor or Call Center Agent, set their permissions once, and assign whole teams
- [Invite Team Members](https://docs.vinsi.ai/organization/inviteTeamMembers.md): Add and manage team members to collaborate on your AI phone agent organization
- [Delete Organization](https://docs.vinsi.ai/organization/deleteOrganization.md): Permanently remove your organization and all associated data from the platform

## Account & Billing

- [Account Settings](https://docs.vinsi.ai/account/settings.md): Update your profile image and name, sign in, reset or change your password, change your sign-in email, set your language, or delete your account.
- [Billing & Plans](https://docs.vinsi.ai/account/billing.md): Support plans, buying minutes, auto recharge, invoices, and cancelling subscriptions
- [API Keys](https://docs.vinsi.ai/account/apiKeys.md): Create, use, and revoke API keys for the VINSI API

## AI Phone Agents

- [Create an AI Phone Agent](https://docs.vinsi.ai/ai-phone-agents/create-agent.md): Step-by-step guide to creating and configuring a new AI phone agent
- [AI Agent Wizard & Templates](https://docs.vinsi.ai/ai-phone-agents/agent-wizard.md): Start new agents fast: generate a call flow from your business details or a PDF/DOCX, or begin from one of 7 templates.
- [Voices](https://docs.vinsi.ai/ai-phone-agents/voices.md): Browse and preview AI voices, then give agents one voice or a rotating set using Cycling or Random selection mode.
- [Website Widget](https://docs.vinsi.ai/ai-phone-agents/website-widget.md): Embed your AI agent on your website for browser voice calls, text chat, or instant Call me callbacks. Setup, domains, install.
- [Setting Up Phone Numbers](https://docs.vinsi.ai/ai-phone-agents/setting-up-phone-numbers.md): Configure phone numbers for your AI agents to make and receive calls
- [What is SIP Trunking?](https://docs.vinsi.ai/ai-phone-agents/what-is-sip-trunking.md): Understand SIP trunking technology and how it enables AI phone communications
- [Batch Calling](https://docs.vinsi.ai/telephony/batchCall.md): Reach large contact lists automatically using AI-powered batch calling campaigns

## Phone Connections

- [Connecting Your Phone System](https://docs.vinsi.ai/phone-connections/overview.md): Compare the ways to connect numbers and phone systems to VINSI AI agents, and pick the one that fits
- [Twilio](https://docs.vinsi.ai/ai-phone-agents/elastic-sip-trunking.md): Connect numbers in your own Twilio account with an Elastic SIP Trunk
- [Telnyx](https://docs.vinsi.ai/phone-connections/telnyx.md): Use numbers bought in VINSI, or connect numbers in your own Telnyx account with a SIP trunk
- [Mitel](https://docs.vinsi.ai/phone-connections/mitel.md): Link Mitel MiVoice Business through VINSI's SBC so AI agents can transfer to extensions
- [3CX](https://docs.vinsi.ai/phone-connections/3cx.md): Forward 3CX calls to an AI agent, or link 3CX with a SIP trunk for extension transfers
- [Zoom Phone](https://docs.vinsi.ai/phone-connections/zoom.md): Forward Zoom Phone calls to an AI agent and transfer callers back to your team

## AI Assistant

- [Chat](https://docs.vinsi.ai/ai-assistant/chat.md): Chat with an AI agent that has access to your organization's knowledge base
- [Knowledge Base](https://docs.vinsi.ai/ai-assistant/knowledge-base.md): Upload and manage documents that power your organization's AI assistant
- [Widgets & Settings](https://docs.vinsi.ai/ai-assistant/widgets.md): Embed your AI Assistant on your websites as a floating or inline chat, and set its name, logo, persona and rate limit.

## QA Calls

- [Dashboard](https://docs.vinsi.ai/qa/dashboard.md): Get an at-a-glance view of your QA call activity, scores, and performance trends
- [Campaigns](https://docs.vinsi.ai/qa/campaigns.md): Create and manage QA campaigns to evaluate calls against defined criteria and scoring rules
- [Upload](https://docs.vinsi.ai/qa/upload.md): Upload call recordings to be scored and reviewed within your QA campaigns
- [Results](https://docs.vinsi.ai/qa/results.md): Review scored call results, agent performance, and QA feedback across your campaigns
- [Agents](https://docs.vinsi.ai/qa/agents.md): Manage and track the agents being evaluated within your QA call campaigns
- [Extensions](https://docs.vinsi.ai/qa/extensions.md): Score QA calls by phone extension: add extensions, link each to a campaign, and set files per run.
- [Analytics](https://docs.vinsi.ai/qa/analytics.md): Analyze QA performance trends, scoring patterns, and agent improvement over time
- [QA Tools](https://docs.vinsi.ai/qa/tools.md): Agent benchmarks, score distribution, low performers, volume vs score, and QA alerts for scored calls.
- [QA Admin](https://docs.vinsi.ai/qa/admin.md): Admin-only QA settings: evaluation mode, score tiers, score display, and analysis run history with unmatched recordings.

## Tickets

- [Adding Tickets](https://docs.vinsi.ai/tickets/overview.md): Create and track support tickets for your customers and team
- [Ticket Dashboard](https://docs.vinsi.ai/tickets/dashboard.md): Get an at-a-glance view of ticket health, priorities, and workload across your team
- [Ticket & Task Management](https://docs.vinsi.ai/tickets/tickets.md): View and manage all submitted tickets across your organization
- [Catalog](https://docs.vinsi.ai/tickets/catalog.md): Browse and manage the service catalog for categorizing and routing ticket requests
- [Workflow](https://docs.vinsi.ai/tickets/workflow.md): Configure automated workflows to route, escalate, and resolve tickets efficiently
- [Knowledge Base](https://docs.vinsi.ai/tickets/knowledge-base.md): Access and manage articles and documentation to help resolve common issues faster
- [Assets](https://docs.vinsi.ai/tickets/assets.md): Track hardware and equipment, assign it to people, import/export CSV, and print QR labels that let anyone open a ticket.
- [Requester Portal](https://docs.vinsi.ai/tickets/portal.md): Requesters sign in with an emailed one-time code to track the status and details of their tickets.
- [Analytics](https://docs.vinsi.ai/tickets/analytics.md): Analyze ticket trends, resolution times, and team performance with detailed reports
- [Admin](https://docs.vinsi.ai/tickets/admin.md): Configure ticketing system settings, permissions, and team management options

## CRM

- [Dashboard](https://docs.vinsi.ai/crm/dashboard.md): Get a real-time snapshot of your pipeline value, contacts, engagements, and personal workload
- [Contacts](https://docs.vinsi.ai/crm/contacts.md): View, manage, and organize all your CRM contacts — leads and customers — in one place
- [Companies](https://docs.vinsi.ai/crm/companies.md): Track and manage all the companies your team works with, including clients and prospects
- [Deals](https://docs.vinsi.ai/crm/deals.md): Track every deal in your pipeline from first contact to closed won
- [Activities](https://docs.vinsi.ai/crm/activities.md): Log and review all the interactions your team has had with contacts and companies
- [Tasks](https://docs.vinsi.ai/crm/tasks.md): Add to-dos to CRM activities, assign owners and due dates, track overdue work and move tasks through a list or Kanban board.
- [Calendar](https://docs.vinsi.ai/crm/calendar.md): See Google, Microsoft and VINSI events in one calendar; schedule meetings linked to CRM records, send invites and set reminders.
- [Documents](https://docs.vinsi.ai/crm/documents.md): Access and manage all documents associated with your CRM contacts, companies, and deals
- [Engagements](https://docs.vinsi.ai/crm/engagements.md): Manage and track every customer engagement from initial outreach through to close
- [Invoices](https://docs.vinsi.ai/crm/invoices.md): Create, manage, and track invoices linked to your CRM contacts, companies, and deals
- [Overview](https://docs.vinsi.ai/crm/admin.md): Overview of CRM Administration
- [Team Settings](https://docs.vinsi.ai/crm/admin/team-settings.md): Connect Google and Microsoft, configure timezone, email settings, and manage CRM team access
- [CRM Configuration](https://docs.vinsi.ai/crm/admin/crm-configuration.md): Manage pipelines, lead statuses, dispositions, contact sources, and custom fields
- [Email Templates](https://docs.vinsi.ai/crm/email-templates.md): Create reusable email templates with merge tags for consistent, personalized outreach
- [Invoice Settings](https://docs.vinsi.ai/crm/admin/invoice-settings.md): Configure invoice company profile and connect Stripe for payment collection
- [Data & Automation](https://docs.vinsi.ai/crm/admin/data-automation.md): Import contacts, run email campaigns, build workflows, and monitor email reports
- [Admin Reports](https://docs.vinsi.ai/crm/reports.md): View 20+ built-in CRM reports with charts across contacts, deals, orders, calls, and more
- [Phone](https://docs.vinsi.ai/crm/admin/phone.md): Manage phone numbers, call logs, softphone settings, and AI Coach profiles
- [Phone Settings](https://docs.vinsi.ai/crm/softphone.md): Phone Settings tabs at a glance, getting started, and links to every phone system guide

## Telephony

- [Overview](https://docs.vinsi.ai/telephony/telephonyOverview.md): Complete overview of telephony features and capabilities for AI phone agents
- [Outbound Calls](https://docs.vinsi.ai/telephony/outboundCalls.md): Set up and test outbound calling functionality for your AI phone agents
- [Phone Numbers & Caller ID](https://docs.vinsi.ai/telephony/phoneNumbers.md): Buy and release numbers, the default main line, outbound caller ID, and CNAM caller ID names
- [Softphone](https://docs.vinsi.ai/telephony/softphone.md): Make and receive calls in the browser: setup, dialing, transfer, conference, missed calls, and audio settings
- [Desk Phones](https://docs.vinsi.ai/telephony/deskPhones.md): Provision Fanvil desk phones, shared lines, busy-lamp keys, feature codes, and troubleshooting
- [Voicemail](https://docs.vinsi.ai/telephony/voicemail.md): Set up AI voicemail greetings, email notifications with transcripts, and listen from softphone, dashboard, or *97
- [Text Messages](https://docs.vinsi.ai/telephony/textMessages.md): Send and receive texts and picture messages from personal or shared team inboxes, with unread email alerts and delivery tips.
- [Call Logs & Recordings](https://docs.vinsi.ai/telephony/callLogs.md): Search calls, play and download recordings, read transcripts and summaries, and export
- [Fax](https://docs.vinsi.ai/telephony/fax.md): Set up fax numbers, send PDFs, and receive faxes by email
- [Phone Dashboard & My Call Log](https://docs.vinsi.ai/telephony/phoneDashboard.md): Phone menu, usage charts for calls, texts and faxes, exportable reports, and your personal call history.
- [Business Hours](https://docs.vinsi.ai/telephony/businessHours.md): Open hours and after-hours routing to voicemail, an AI phone agent, or another queue
- [Hunt Groups](https://docs.vinsi.ai/telephony/huntGroups.md): Ring a team when a number is called: ring all, linear, round robin, longest idle, or by skill, with business hours and voicemail
- [Call Queues](https://docs.vinsi.ai/telephony/queues.md): Hold callers in line until an agent is free: agent status, wrap-up, callbacks, supervisor wallboard, listen/whisper/barge, and reports
- [Skills-Based Routing](https://docs.vinsi.ai/telephony/skillsRouting.md): Create skills, rate members Primary/Secondary/Training, and ring the best-suited people first
- [Call Center](https://docs.vinsi.ai/telephony/callCenter.md): Supervisor wallboard, listen/whisper/barge, alerts, reason and disposition codes, and queue and agent reports
- [Call Screening](https://docs.vinsi.ai/telephony/callScreening.md): Screen spam calls and block specific callers org-wide or per number

## VINSI Video Meetings

- [Scheduling Meetings](https://docs.vinsi.ai/meet/overview.md): Schedule VINSI Meet video meetings, send invites, connect Google or Outlook calendars, and custom backgrounds
- [Joining & In-Meeting Controls](https://docs.vinsi.ai/meet/joining.md): Join from an invite, waiting room, screen share, captions and translation, chat, breakout rooms, and host controls
- [Recording & AI Summaries](https://docs.vinsi.ai/meet/recording.md): Record meetings, find and download recordings, and generate AI meeting summaries
- [Remote Control](https://docs.vinsi.ai/meet/remote-control.md): Install VINSI Remote and give or take control of a shared screen during a meeting

## Tools

- [DTMF](https://docs.vinsi.ai/tools/dtmf.md): Enable dual-tone multi-frequency (DTMF) input for interactive voice response systems
- [Function](https://docs.vinsi.ai/tools/function.md): Create custom functions and tools to extend your AI phone agent capabilities
- [After Call Actions](https://docs.vinsi.ai/tools/after-call-actions.md): Automatically email your team or create a VINSI Desk ticket when a call ends with a chosen disposition, plus the webhook payload.

## API Integration

- [HubSpot](https://docs.vinsi.ai/api-integration/hubspot.md): Connect your AI phone agents with HubSpot CRM for seamless contact management
- [Salesforce](https://docs.vinsi.ai/api-integration/salesforce.md): Integrate Salesforce CRM to sync call data and automate workflows with AI agents
- [GoHighLevel](https://docs.vinsi.ai/api-integration/gohighlevel.md): Connect GoHighLevel platform to manage leads and campaigns with AI phone agents
- [Epic](https://docs.vinsi.ai/api-integration/epic.md): Connect AI phone agents to Epic on FHIR for patient lookup and appointment scheduling
- [Vinsi CRM](https://docs.vinsi.ai/api-integration/vinsi-crm.md): Connect your AI phone agents to the Vinsi CRM platform

## API Reference

- [Calls](https://docs.vinsi.ai/api-docs/calls.md): Retrieve a list of all calls made by your AI phone agents with filtering options
- [Call by ID](https://docs.vinsi.ai/api-docs/call-id.md): Get detailed information about a specific call using its unique identifier
- [Start Outbound Call](https://docs.vinsi.ai/api-docs/call-outbound.md): Have an AI phone agent call a phone number now, with optional variables and a voicemail message
- [Export Call](https://docs.vinsi.ai/api-docs/export-calls.md): Export call logs and recordings in various formats for analysis and compliance
- [Signed URL](https://docs.vinsi.ai/api-docs/signed-url.md): Generate secure, time-limited URLs for accessing call recordings and media files
- [All Agents](https://docs.vinsi.ai/api-docs/agents.md): Retrieve a complete list of all AI phone agents in your organization
- [Agent by ID](https://docs.vinsi.ai/api-docs/agent-id.md): Get detailed configuration and settings for a specific AI phone agent
- [Create Agent](https://docs.vinsi.ai/api-docs/agent-create.md): Programmatically create a new AI phone agent with custom configurations via API
- [Update Agent](https://docs.vinsi.ai/api-docs/agent-update.md): Modify existing AI phone agent settings, voice, and behavior through the API
- [Delete Agent](https://docs.vinsi.ai/api-docs/agent-delete.md): Permanently remove an AI phone agent from your organization using the API
- [All Voices](https://docs.vinsi.ai/api-docs/voices.md): Browse available voice options and languages for your AI phone agents
- [All Phone Numbers](https://docs.vinsi.ai/api-docs/phone-numbers.md): List all phone numbers registered and available in your organization
- [Phone Number by ID](https://docs.vinsi.ai/api-docs/phone-number-id.md): Get a single phone number with its assigned agent and routing details
- [Update Phone Number](https://docs.vinsi.ai/api-docs/phone-number-update.md): Assign an AI agent or fallback number to a phone number
- [Get By Area Code](https://docs.vinsi.ai/api-docs/phone-numbers-area-code.md): Search and filter available phone numbers by specific area code or region
- [Create Phone Number](https://docs.vinsi.ai/api-docs/phone-number-create.md): Provision and register a new phone number for your AI agents via API
- [Get Contacts](https://docs.vinsi.ai/api-docs/crm-contacts.md): List CRM contacts with search, filters, and pagination
- [Contact by ID](https://docs.vinsi.ai/api-docs/crm-contact-id.md): Get a single CRM contact by its ID
- [Find Contact by Phone](https://docs.vinsi.ai/api-docs/crm-contact-lookup-by-phone.md): Look up a CRM contact by phone number
- [Create Contact](https://docs.vinsi.ai/api-docs/crm-contact-create.md): Create a new CRM contact
- [Update Contact](https://docs.vinsi.ai/api-docs/crm-contact-update.md): Update an existing CRM contact
- [Delete Contact](https://docs.vinsi.ai/api-docs/crm-contact-delete.md): Delete a CRM contact
- [Get Companies](https://docs.vinsi.ai/api-docs/crm-companies.md): List CRM companies with search, filters, and pagination
- [Company by ID](https://docs.vinsi.ai/api-docs/crm-company-id.md): Get a single CRM company by its ID
- [Create Company](https://docs.vinsi.ai/api-docs/crm-company-create.md): Create a new CRM company
- [Update Company](https://docs.vinsi.ai/api-docs/crm-company-update.md): Update an existing CRM company
- [Delete Company](https://docs.vinsi.ai/api-docs/crm-company-delete.md): Delete a CRM company, optionally with its related records
- [Get Deals](https://docs.vinsi.ai/api-docs/crm-deals.md): List CRM deals with filters and pagination
- [Deal by ID](https://docs.vinsi.ai/api-docs/crm-deal-id.md): Get a single CRM deal by its ID
- [Create Deal](https://docs.vinsi.ai/api-docs/crm-deal-create.md): Create a new CRM deal
- [Update Deal](https://docs.vinsi.ai/api-docs/crm-deal-update.md): Update an existing CRM deal
- [Delete Deal](https://docs.vinsi.ai/api-docs/crm-deal-delete.md): Delete a CRM deal
- [Get Activities](https://docs.vinsi.ai/api-docs/crm-activities.md): List CRM activities with filters and pagination
- [Activity by ID](https://docs.vinsi.ai/api-docs/crm-activity-id.md): Get a single CRM activity by its ID
- [Create Activity](https://docs.vinsi.ai/api-docs/crm-activity-create.md): Create a new CRM activity
- [Update Activity](https://docs.vinsi.ai/api-docs/crm-activity-update.md): Update an existing CRM activity
- [Delete Activity](https://docs.vinsi.ai/api-docs/crm-activity-delete.md): Delete a CRM activity
- [Get Activity Tasks](https://docs.vinsi.ai/api-docs/crm-activity-tasks.md): List the tasks on a CRM activity
- [Activity Task by ID](https://docs.vinsi.ai/api-docs/crm-activity-task-id.md): Get a single activity task by its ID
- [Create Activity Task](https://docs.vinsi.ai/api-docs/crm-activity-task-create.md): Add a task to a CRM activity
- [Update Activity Task](https://docs.vinsi.ai/api-docs/crm-activity-task-update.md): Update an activity task
- [Delete Activity Task](https://docs.vinsi.ai/api-docs/crm-activity-task-delete.md): Delete an activity task
- [All Tools](https://docs.vinsi.ai/api-docs/tools.md): List all custom tools and functions configured for your AI phone agents
- [Tool by ID](https://docs.vinsi.ai/api-docs/tool-id.md): Retrieve detailed configuration and parameters for a specific tool by its ID
- [Create Tool](https://docs.vinsi.ai/api-docs/tool-create.md): Create custom tools to extend AI agent functionality and integrate external APIs
- [Update Tool](https://docs.vinsi.ai/api-docs/tool-update.md): Modify existing tool configurations, parameters, and integration settings
- [Delete Tool](https://docs.vinsi.ai/api-docs/tool-delete.md): Remove a custom tool from your AI phone agent's available capabilities