# telli API Documentation

## Docs

- [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
- [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, Cal.com, HubSpot Meetings, or a custom calendar API.
- [Changelog](https://docs.telli.com/changelog.md): We're constantly shipping new features and improvements. Here's what's new in telli.
- [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
- [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.
- [Call Outcomes](https://docs.telli.com/cookbooks/call-outcomes/overview.md): Automatically extract structured information from every call your telli agent handles.
- [Collect Data](https://docs.telli.com/cookbooks/collect-data/overview.md): Let your telli agent actively gather specific pieces of information from callers during a conversation.
- [Overview](https://docs.telli.com/cookbooks/how-to-prompt/overview.md): Why prompting matters and how to approach it effectively.
- [Context & Customer Data & Tool Calls](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/context-customer-data-tool-calls.md)
- [Global Rules & Behavior](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/global-rules-behavior.md)
- [Identity & Core Task](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/identity-core-task.md)
- [Main Conversation Script](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/main-conversation-script.md)
- [Pronunciation & Formatting](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/pronunciation-formatting.md)
- [Special Situations / FAQs](https://docs.telli.com/cookbooks/how-to-prompt/prompt-structure/special-situations-faqs.md)
- [What cannot be prompted](https://docs.telli.com/cookbooks/how-to-prompt/what-cannot-be-influenced.md)
- [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.
- [Cookbooks](https://docs.telli.com/cookbooks/overview.md): Practical guides and examples for building with telli.
- [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.
- [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.
- [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.
- [Custom HTTP Tools](https://docs.telli.com/custom-tools.md): Enable your AI agents to call external APIs during conversations
- [Agent Builder](https://docs.telli.com/deep-dives/agent-builder.md): Build, refine, and publish your agents from one cockpit
- [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
- [Call Transfer](https://docs.telli.com/deep-dives/call-transfer.md): Transfer calls to human agents with cold or warm transfer options
- [Data Collection](https://docs.telli.com/deep-dives/collected-data.md): Actively collect and validate structured data from callers during a call
- [Feedback System](https://docs.telli.com/deep-dives/feedback-system.md): Improve your agent through iterative feedback
- [Get Started](https://docs.telli.com/en/get-started.md): Follow this checklist to achieve results with your first telli agent
- [Add Customer Context](https://docs.telli.com/en/get-started/add-customer-context.md): Provide your agent with customer information
- [Agent Persona](https://docs.telli.com/en/get-started/agent-persona.md): Customize your agent's voice, name, and tone
- [Optimize Conversation Flow](https://docs.telli.com/en/get-started/conversation-flow.md): Refine your agent's prompt based on test results
- [Create an Agent](https://docs.telli.com/en/get-started/create-an-agent.md): Create your first AI voice agent
- [Your first Agent](https://docs.telli.com/en/get-started/introduction.md): Set up your first agent from scratch
- [Test Your Agent](https://docs.telli.com/en/get-started/test-your-agent.md): Test your agent with a live call
- [Add Contact](https://docs.telli.com/endpoint/add-contact.md): Adds a new contact to the system
- [Add Contacts (Batch)](https://docs.telli.com/endpoint/add-contacts-batch.md): Adds multiple contacts in a single request. Limited to 1000 contacts per request.
- [Delete Contact](https://docs.telli.com/endpoint/delete-contact.md): Permanently deletes a contact and any PII data associated with it from the system. This action cannot be undone. If you want to stop calling a contact, use the `v1/remove-from-auto-dialer` endpoint instead.
- [Delete Phone Number](https://docs.telli.com/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.
- [Get Call](https://docs.telli.com/endpoint/get-call.md): Retrieves detailed information about a specific call by its ID, including call metadata, transcript, analysis, and the associated contact.
- [Get Contact](https://docs.telli.com/endpoint/get-contact.md): Retrieves detailed contact information including current call status and history
- [Get Contact by External ID](https://docs.telli.com/endpoint/get-contact-by-external-id.md): Retrieves detailed contact information including current call status and history using external contact id as an identifier
- [Get Contacts (Batch)](https://docs.telli.com/endpoint/get-contacts-batch.md): Gets multiple contacts in a single request. Limited to 1000 contacts per request.
- [Import Phone Number](https://docs.telli.com/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.
- [Initiate Call](https://docs.telli.com/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.
- [List Calls](https://docs.telli.com/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…
- [List Phone Numbers](https://docs.telli.com/endpoint/list-phone-numbers.md): Retrieves all active phone numbers associated with the account
- [Remove from Auto Dialer](https://docs.telli.com/endpoint/remove-from-dialer.md): Removes a contact from the auto dialer queue
- [Remove from Auto Dialer (Batch)](https://docs.telli.com/endpoint/remove-from-dialer-batch.md): Removes multiple contacts from the auto dialer queue. Limited to 50 contacts per request.
- [Replace Phone Number](https://docs.telli.com/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.
- [Schedule Call](https://docs.telli.com/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/endpoint/schedule-calls-batch.md): Schedules multiple calls in a single request. Limited to 50 contacts per request.
- [Update Contact](https://docs.telli.com/endpoint/update-contact.md): Updates an existing contact. Only provided fields will be updated, others remain unchanged.
- [Update Contacts (Batch)](https://docs.telli.com/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 notified about calls](https://docs.telli.com/get-notified-about-calls.md): Get notified about calls and their analysis using webhooks to automatically update your CRM
- [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.
- [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.
- [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.
- [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.
- [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.
- [HubSpot](https://docs.telli.com/integrations/hubspot.md): HubSpot CRM support for telli is coming soon. This page will become the home for setup, sync behavior, and mapping guidance.
- [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.
- [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.
- [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.
- [Salesforce](https://docs.telli.com/integrations/salesforce.md): Connect Salesforce to telli to sync Contacts and Leads into your workspace and map CRM fields to telli contact properties.
- [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.
- [Introduction](https://docs.telli.com/introduction.md): telli API Documentation
- [Agents](https://docs.telli.com/platform/agents.md): Manage and configure your AI Voice agents
- [Call History](https://docs.telli.com/platform/call-history.md): Comprehensive view of all call interactions and analysis
- [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
- [Contacts](https://docs.telli.com/platform/contacts.md): Full visibility into your contact outreach
- [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
- [Live Monitoring](https://docs.telli.com/platform/live-monitoring.md): Real-time call overview of your contacts
- [Performance Dashboard](https://docs.telli.com/platform/performance-dashboard.md): Real-time performance metrics for your telli Agent
- [Phone Numbers](https://docs.telli.com/platform/phone-numbers.md): Buy and manage phone numbers directly in telli
- [Settings](https://docs.telli.com/platform/settings.md): Manage your telli account settings and preferences
- [Prompt Best Practices](https://docs.telli.com/prompt-best-practices.md): Learn how to write effective prompts for your voice agents
- [Receive call data](https://docs.telli.com/receive-call-data.md): Receive call data and their analysis using webhooks to automatically update your CRM
- [SIP numbers](https://docs.telli.com/sip-numbers.md): Connect your existing SIP providers to telli
- [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
- [Create Contact](https://docs.telli.com/v2/endpoint/create-contact.md): Creates a new contact. Properties are validated against the account's property schema.
- [Create Contact Property](https://docs.telli.com/v2/endpoint/create-contact-property.md): Creates a new contact property for the authenticated account.
- [Delete Contact](https://docs.telli.com/v2/endpoint/delete-contact.md): Soft-deletes a contact and anonymizes all PII data.
- [Get Agent](https://docs.telli.com/v2/endpoint/get-agent.md): Returns a single agent by ID.
- [Get Contact](https://docs.telli.com/v2/endpoint/get-contact.md): Returns a single contact by ID.
- [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.
- [Get Contact Property](https://docs.telli.com/v2/endpoint/get-contact-property.md): Returns a single contact property by key.
- [List Agents](https://docs.telli.com/v2/endpoint/list-agents.md): Returns a paginated list of agents for the authenticated account.
- [List Contact Properties](https://docs.telli.com/v2/endpoint/list-contact-properties.md): Returns all contact properties for the authenticated account.
- [List Contacts](https://docs.telli.com/v2/endpoint/list-contacts.md): Returns a paginated list of contacts for the authenticated account.
- [Update Contact](https://docs.telli.com/v2/endpoint/update-contact.md): Updates an existing contact. Properties are merged with existing ones after validation.
- [Update Contact Property](https://docs.telli.com/v2/endpoint/update-contact-property.md): Updates an existing contact property by key.
- [Update Contact (PUT)](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.

## OpenAPI Specs

- [openapi](https://docs.telli.com/openapi.json)
- [openapi-v2](https://docs.telli.com/openapi-v2.json)
- [package](https://docs.telli.com/package.json)
- [package-lock](https://docs.telli.com/package-lock.json)