# telli Documentation

> telli is the AI voice platform for agents that sell, support, and operate across millions of calls. These docs cover the telli platform, building and deploying agents, CRM and calendar integrations, cookbooks, and the REST API.

## Get Started

- [Get Started](https://docs.telli.com/en/get-started.md): Follow this checklist to achieve results with your first telli agent

### Build Your First Agent

- [Agent Creation Overview](https://docs.telli.com/en/get-started/introduction.md): Set up your first agent from scratch

#### Step 1: Create the Agent

- [Create an Agent](https://docs.telli.com/en/get-started/create-a-new-agent.md): Create your first AI voice agent
- [The telli Agent Interface](https://docs.telli.com/en/get-started/review-and-personalize.md): Customize how your agent sounds, how it handles calls, and what it captures from every conversation.

#### Step 2: Customize the Agent

- [Agent Editor Charlie](https://docs.telli.com/en/get-started/agent-editor-charlie.md): Use Charlie to review and improve your agent
- [Working with Variables](https://docs.telli.com/en/get-started/working-with-variables.md): Personalize every call with contact info, dates, and details that change per contact

#### Step 3: Test, Refine & Publish

- [Test Your Agent](https://docs.telli.com/en/get-started/test-your-agent.md): Test your agent with a live call
- [Refine your Agent](https://docs.telli.com/en/get-started/refine-your-agent.md): Improve your agent based on real call data
- [Publish your Agent](https://docs.telli.com/en/get-started/publish-your-agent.md): Make your draft changes go live for new calls

#### Advanced Capabilities

- [Tool Calls](https://docs.telli.com/en/get-started/tool-calls.md): Let your agent take action during a call
- [Knowledge Bases](https://docs.telli.com/en/get-started/knowledge-bases.md): Give your agent access to your own documents during calls
- [Voice Cloning](https://docs.telli.com/en/get-started/voice-cloning.md): Give your agent a custom voice
- [Workflows](https://docs.telli.com/en/get-started/workflows.md): Automate actions that fire after every call

## Product

- [Introduction](https://docs.telli.com/introduction.md): Overview of the telli platform and what you can build with it
- [Get started with telli](https://docs.telli.com/get-started-with-telli.md): This tutorial demonstrates how to use any integration platform to automate adding contacts, scheduling calls, and updating CRM contact status based on call outcomes.
- [The EU's disclosure requirements](https://docs.telli.com/eu-ai-act-transparency.md)
- [Changelog](https://docs.telli.com/changelog.md): We're constantly shipping new features and improvements. Here's what's new in telli.

### Platform

- [Charlie](https://docs.telli.com/platform/charlie.md): Meet Charlie, the AI assistant built into telli that builds agents, automates workflows, and analyzes your calls with you
- [Performance Dashboard](https://docs.telli.com/platform/performance-dashboard.md): Real-time performance metrics for your telli Agent
- [Contacts](https://docs.telli.com/platform/contacts.md): Full visibility into your contact outreach
- [Contact Properties](https://docs.telli.com/platform/contact-properties.md): Define a structured schema for your contacts with typed custom properties that you can use across the telli platform
- [Conversation History](https://docs.telli.com/platform/call-history.md): Comprehensive view of all call interactions and analysis
- [Workflows](https://docs.telli.com/platform/workflows.md): Automate actions across calls, contacts, and integrations with visual workflows in telli
- [SMS](https://docs.telli.com/platform/sms.md): Send SMS messages from agents and workflows in telli
- [WhatsApp Business](https://docs.telli.com/integrations/whatsapp.md): Send WhatsApp template messages from agents and workflows in telli
- [Live Monitoring](https://docs.telli.com/platform/live-monitoring.md): Real-time call overview of your contacts
- [Agents](https://docs.telli.com/platform/agents.md): Manage and configure your AI Voice agents
- [Settings](https://docs.telli.com/platform/settings.md): Manage your telli account settings and preferences
- [Data Retention](https://docs.telli.com/platform/data-retention.md): Delete contacts and call data automatically after a set time
- [Phone Numbers](https://docs.telli.com/platform/phone-numbers.md): Buy a telli number, connect your own number, or forward calls to your agent
- [Branded Calling](https://docs.telli.com/platform/branded-calling.md): Show your verified business name on recipients' phones during outbound calls
- [Knowledge Base](https://docs.telli.com/platform/knowledge-base.md): Enrich your AI agent with the expertise and context it needs by including all of your knowledge sources

### Deep Dives

- [Agent Builder](https://docs.telli.com/deep-dives/agent-builder.md): Build, refine, and publish your agents from one cockpit
- [Prompt Best Practices](https://docs.telli.com/prompt-best-practices.md): Learn how to write effective prompts for your voice agents
- [Feedback System](https://docs.telli.com/deep-dives/feedback-system.md): Improve your agent through iterative feedback
- [Auto-Dialer](https://docs.telli.com/deep-dives/auto-dialer.md): Automated contact outreach system
- [Call Analysis](https://docs.telli.com/deep-dives/call-analysis.md): Understand conversation insights and outcomes
- [Data Collection](https://docs.telli.com/deep-dives/collected-data.md): Actively collect and validate structured data from callers during a call
- [Call Transfer](https://docs.telli.com/deep-dives/call-transfer.md): How cold and warm transfers use fixed destinations or Phone Number contact properties

## Developer

- [Overview](https://docs.telli.com/integrations-overview.md): Learn how to integrate telli with your existing tools and workflows. This enables you to automate contact management, schedule calls, and sync call outcomes with your CRM or other systems.

### CRM

- [Integrate with your CRM](https://docs.telli.com/crm-integration.md): Integrate telli with your CRM to sync contacts and call data. This enables you to automate contact management, schedule calls, and sync call outcomes with your CRM or other systems.
- [Add contacts & schedule calls](https://docs.telli.com/add-contacts-and-schedule-calls.md): Add contacts to telli from your CRM or other systems and schedule calls with them

#### Providers

- [Salesforce](https://docs.telli.com/integrations/salesforce.md): Connect Salesforce to telli to sync Contacts, Leads, and Person Accounts into your workspace and map CRM fields to telli contact properties.
- [HubSpot](https://docs.telli.com/integrations/hubspot.md): Connect HubSpot to telli to sync Contacts into your workspace and map HubSpot properties to telli contact properties.

### Webhooks

- [Webhooks](https://docs.telli.com/webhooks.md): Receive call outcomes, transcripts, and analysis in your own systems as soon as they happen

#### Events

- [Call ended](https://docs.telli.com/webhooks/events/call-ended.md): Payload telli sends when a call reaches a terminal state
- [Call rescheduled](https://docs.telli.com/webhooks/events/call-rescheduled.md): Receive the later call time selected by the scheduler
- [Auto dialer status changed](https://docs.telli.com/webhooks/events/auto-dialer-status-changed.md): Payload telli sends when a contact enters or exits the auto dialer
- [Contact status changed](https://docs.telli.com/webhooks/events/contact-status-changed.md): Deprecated payload telli sends when a contact's status changes

### Calendar Integrations

- [Connect your calendar](https://docs.telli.com/calendar-integrations.md): Choose the right calendar integration for your telli agents and configure booking workflows for Calendly, Zeeg, Cal.com, HubSpot Meetings, or a custom calendar API.

#### Providers

- [bookingtime](https://docs.telli.com/integrations/bookingtime.md): Connect bookingtime to telli so agents can check availability and book appointments into your bookingtime calendar during calls.
- [Calendly](https://docs.telli.com/integrations/calendly.md): Connect Calendly to telli so agents can check availability, book meetings, and fill Calendly booking questions during calls.
- [Zeeg](https://docs.telli.com/integrations/zeeg.md): Connect Zeeg to telli so agents can check availability, book meetings, and fill Zeeg scheduling page questions during calls.
- [Cal.com](https://docs.telli.com/integrations/cal-com.md): Connect Cal.com to telli so agents can book meetings against your Cal.com availability during calls.
- [HubSpot Meetings](https://docs.telli.com/integrations/hubspot-meetings.md): Connect HubSpot Meetings to telli so agents can book appointments through HubSpot meeting links during calls.
- [Custom calendar](https://docs.telli.com/integrations/custom-calendar.md): Connect your own calendar or scheduling API to telli so agents can fetch availability and book appointments through custom endpoints.

### Automation Platforms

- [Make](https://docs.telli.com/integrations/make.md): This tutorial demonstrates how to use the verified telli integration in [Make.com](https://www.make.com) to automate adding contacts, scheduling calls, and getting call data.
- [Zapier](https://docs.telli.com/integrations/zapier.md): This tutorial demonstrates how to use [Zapier](https://www.zapier.com) to automate adding contacts, scheduling calls, and updating CRM contact status based on call outcomes.
- [n8n](https://docs.telli.com/integrations/n8n.md): This tutorial demonstrates how to use the verified telli node in [n8n](https://n8n.io) to automate adding contacts, scheduling calls, and updating CRM contact status based on call outcomes.
- [MCP](https://docs.telli.com/integrations/mcp.md): Connect Claude, ChatGPT, and other AI tools to Charlie through the telli MCP server.
- [Slack](https://docs.telli.com/integrations/slack.md): Install Charlie in your Slack workspace so your team can ask about agents and calls by mentioning it in a channel.
- [Microsoft Teams](https://docs.telli.com/integrations/microsoft-teams.md): Connect Charlie to your Microsoft 365 tenant so your team can message it in Microsoft Teams.

### Custom Integrations

- [Custom HTTP Tools](https://docs.telli.com/custom-tools.md): Enable your AI agents to call external APIs during conversations
- [Contact lookup webhook](https://docs.telli.com/contact-lookup-webhook.md): Identify unknown callers by looking up their phone number in your system before the call starts

### Reference

- [Phone Number Format](https://docs.telli.com/phone-number-format.md): Which phone number formats telli accepts, how numbers are normalized, and why everything is stored in E.164

## API

- [Getting Started with the telli API](https://docs.telli.com/api-getting-started.md): Start building with the telli API: authenticate with your API key, explore the endpoints, and download the OpenAPI specifications

### Contact Property Endpoints

- [List Contact Properties](https://docs.telli.com/v2/endpoint/list-contact-properties.md): Returns all contact properties for the authenticated account.
- [Create Contact Property](https://docs.telli.com/v2/endpoint/create-contact-property.md): Creates a new contact property for the authenticated account.
- [Get Contact Property](https://docs.telli.com/v2/endpoint/get-contact-property.md): Returns a single contact property by key.
- [Update Contact Property](https://docs.telli.com/v2/endpoint/update-contact-property.md): Updates an existing contact property by key.

### Contact Endpoints

- [List Contacts](https://docs.telli.com/v2/endpoint/list-contacts.md): Returns a paginated list of contacts for the authenticated account.
- [Create Contact](https://docs.telli.com/v2/endpoint/create-contact.md): Creates a new contact. Properties are validated against the account's property schema.
- [Get Contact](https://docs.telli.com/v2/endpoint/get-contact.md): Returns a single contact by ID.
- [Update Contact](https://docs.telli.com/v2/endpoint/update-contact.md): Updates an existing contact. Properties are merged with existing ones after validation.
- [Replace Contact](https://docs.telli.com/v2/endpoint/update-contact-put.md): Fully replaces an existing contact. All omitted optional fields are reset to their default values (null). Properties are replaced entirely rather than merged.
- [Get Contact by External ID](https://docs.telli.com/v2/endpoint/get-contact-by-external-id.md): Returns a single contact by its external ID.
- [Delete Contact](https://docs.telli.com/v2/endpoint/delete-contact.md): Deletes a contact and all personal data telli stores for it, including the recordings, transcripts, and analyses of its calls. The deletion cannot be undone.

### Agent Endpoints

- [List Agents](https://docs.telli.com/v2/endpoint/list-agents.md): Returns a paginated list of agents for the authenticated account.
- [Get Agent](https://docs.telli.com/v2/endpoint/get-agent.md): Returns a single agent by ID.

### Call Endpoints

- [Get Call](https://docs.telli.com/v1/endpoint/get-call.md): Retrieves detailed information about a specific call by its ID, including call metadata, transcript, analysis, and the associated contact.
- [List Calls](https://docs.telli.com/v1/endpoint/list-calls.md): Returns a paginated list of calls for the authenticated account, ordered by `triggered_at` descending. Optionally filter by `contact_id` to return only calls for a single contact, or by `agent_id` to return only calls for a single agent. `contact_id` and `agent_id` cannot be used together. Each item…
- [Initiate Call](https://docs.telli.com/v1/endpoint/initiate-call.md): [Not recommended] Initiates an immediate call to a contact. Will call even outside business hours, which is why we recommend using schedule-call instead. If contact cannot be reached and Auto Dialer is enabled, telli will continue trying according to Auto Dialer settings.
- [Schedule Call](https://docs.telli.com/v1/endpoint/schedule-call.md): Schedules a call at the earliest opportunity within the dialer window. May occur immediately or on the next business day depending on settings. Requires the auto dialer to be enabled.
- [Schedule Calls (Batch)](https://docs.telli.com/v1/endpoint/schedule-calls-batch.md): Schedules multiple calls in a single request. Limited to 50 contacts per request.
- [Remove from Auto Dialer](https://docs.telli.com/v1/endpoint/remove-from-dialer.md): Removes a contact from the auto dialer queue
- [Remove from Auto Dialer (Batch)](https://docs.telli.com/v1/endpoint/remove-from-dialer-batch.md): Removes multiple contacts from the auto dialer queue. Limited to 50 contacts per request.

### Phone Number Endpoints

- [List Phone Numbers](https://docs.telli.com/v1/endpoint/list-phone-numbers.md): Retrieves all active phone numbers associated with the account
- [Replace Phone Number](https://docs.telli.com/v1/endpoint/replace-phone-number.md): Replaces an existing phone number with a new one with the same configuration. The old number is scheduled for deletion but remains active for callbacks for 30 days.
- [Import Phone Number](https://docs.telli.com/v1/endpoint/import-phone-number.md): Imports a phone number from your own SIP trunk provider. This allows you to use existing phone numbers with telli by configuring custom SIP termination settings.
- [Delete Phone Number](https://docs.telli.com/v1/endpoint/delete-phone-number.md): Schedules a phone number for deletion. The number remains active for callbacks for 30 days and can be restored during this period.

### Deprecated Contact Endpoints

- [Migration Guide](https://docs.telli.com/v2-migration-guide.md): Migrate from the deprecated contact endpoints to the current API for contacts and contact properties
- [Add Contact](https://docs.telli.com/v1/endpoint/add-contact.md): Adds a new contact to the system
- [Add Contacts (Batch)](https://docs.telli.com/v1/endpoint/add-contacts-batch.md): Adds multiple contacts in a single request. Limited to 1000 contacts per request.
- [Update Contact](https://docs.telli.com/v1/endpoint/update-contact.md): Updates an existing contact. Only provided fields will be updated, others remain unchanged.
- [Update Contacts (Batch)](https://docs.telli.com/v1/endpoint/update-contacts-batch.md): Updates multiple contacts in a single request. Limited to 1000 contacts per request. Only provided fields will be updated, others remain unchanged.
- [Get Contact](https://docs.telli.com/v1/endpoint/get-contact.md): Retrieves detailed contact information including current call status and history
- [Get Contacts (Batch)](https://docs.telli.com/v1/endpoint/get-contacts-batch.md): Gets multiple contacts in a single request. Limited to 1000 contacts per request.
- [Get Contact by External ID](https://docs.telli.com/v1/endpoint/get-contact-by-external-id.md): Retrieves detailed contact information including current call status and history using external contact id as an identifier
- [Delete Contact](https://docs.telli.com/v1/endpoint/delete-contact.md): Permanently deletes a contact and all personal data telli stores for it, including the recordings, transcripts, and analyses of its calls. This action cannot be undone. If you want to stop calling a contact, use the `v1/remove-from-auto-dialer` endpoint instead.

## Cookbooks

- [Cookbooks Overview](https://docs.telli.com/cookbooks/overview.md): Practical guides and examples for building with telli.

### Prompting Cookbook

- [Charlie](https://docs.telli.com/cookbooks/charlie/overview.md): Edit your agent's prompt with help from Charlie, telli's built-in AI assistant in the Agent Builder.
- [What cannot be prompted](https://docs.telli.com/cookbooks/how-to-prompt/what-cannot-be-influenced.md)

#### What can be prompted

- [Identity & Core Task](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/identity-core-task.md)
- [Global Rules & Behavior](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/global-rules-behavior.md)
- [Pronunciation & Formatting](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/pronunciation-formatting.md)
- [Context & Customer Data & Tool Calls](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/context-customer-data-tool-calls.md)
- [Main Conversation Script](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/main-conversation-script.md)
- [Special Situations / FAQs](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/special-situations-faqs.md)

### Feature Cookbooks

- [Tool Calls](https://docs.telli.com/cookbooks/tool-calls/overview.md): Let your agent perform specific actions during a call using tool calls.
- [Variables](https://docs.telli.com/cookbooks/variables/overview.md): Learn how to use variables to personalize your agent's prompts dynamically.
- [Call Outcomes](https://docs.telli.com/cookbooks/call-outcomes/overview.md): Automatically extract structured information from every call your telli agent handles.
- [Knowledge Base](https://docs.telli.com/cookbooks/knowledgebase/overview.md): Give your telli agent access to your own documents so it can answer questions using your specific information during calls.
- [Collect Data](https://docs.telli.com/cookbooks/collect-data/overview.md): Let your agent gather specific information from callers with built-in validation and confirmation.
- [Connect your calendar](https://docs.telli.com/cookbooks/calendar-integration/overview.md): Connect a calendar provider so your telli agent can check availability and book appointments during calls.
- [Professional Voice Cloning](https://docs.telli.com/cookbooks/voice-cloning/overview.md): How to create a high-quality professional voice clone for use with your telli agent.
- [Call Transfers](https://docs.telli.com/cookbooks/call-transfers/overview.md): Configure cold or warm call transfers to fixed destinations or Phone Number contact properties.
- [Auto-dialer & Calling Strategy](https://docs.telli.com/cookbooks/auto-dialer/overview.md): Reach out to contacts automatically. Pick a strategy, retry intensity, and dialer windows that fit your campaign.

## OpenAPI Specs

- [openapi-v2](/openapi-v2.json)
- [openapi](/openapi.json)
- [package](/package.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [German (117 pages)](https://docs.telli.com/_llms/de.md): Documentation for German.