DOCSEARCHbyAlgolia
Submit Docs

YourCalls Documentation

website·Indexed 31 days ago

https://docs.yourcalls.ai/

Platform for creating AI agents to handle inbound and outbound voice calls. Includes guides for managing assistants, contacts, and campaigns, as well as a public API for triggering calls and managing contacts via POST /public/v1/calls. Features include a Flow Builder, Zapier Embedded integration, and tools for defining global instructions through Rules.

Tokens
18.1K
Snippets
47
Records
145
Agent score
50%

What's inside YourCalls

  1. Overview of YourCalls Tools

    Tools allow YourCalls assistants to perform specific actions and interact with external systems, such as booking appointments, sending SMS, or transferring calls. Tools are managed via the Tools page, where users can create, edit, delete, and assign tools to specific assistants. The Tools page is divided into 'YourCalls Tools' (internal) and 'External Tools' (embedded platforms like Zapier).

  2. Overview of YourCalls Knowledge Bases

    Knowledge Bases (KB) are repositories of information used by YourCalls Assistants during calls. Assistants only answer questions based on the content within the KBs linked to them, preventing hallucinations by ensuring responses are derived exclusively from uploaded documents rather than general AI memory.

  3. Overview of YourCalls AI Voice Assistant Platform

    YourCalls is an AI-powered voice assistant platform designed to automate inbound and outbound phone calls. It allows businesses to build intelligent AI assistants that can greet callers, qualify leads, answer questions based on a Knowledge Base, transfer calls to human agents, and execute outbound campaigns without requiring code.

  4. Overview of YourCalls Rules

    Rules are reusable global instructions applied consistently across AI assistant conversations. They are used for pronunciation guidance (product names/abbreviations) and response behavior instructions (e.g., requiring the assistant to wait for a user answer). Rules can be managed in the dashboard at /client/rules and are categorized into 'Your Rules' (team-created) and 'Public Rules' (starter templates).

  5. Understand YourCalls core platform concepts

    The YourCalls platform uses the following primary entities to manage AI-driven telephony:

    • Assistant: An AI agent with a specific persona, voice, and instructions for inbound or outbound calls.
    • Visual Flow Builder: A drag-and-drop canvas used to design conversational logic via nodes and edges.
    • Campaign: A batch of outbound calls made by an assistant to a contact list, featuring configurable scheduling and concurrency.
    • Knowledge Base (KB): A repository of uploaded documents (PDF, TXT, DOCX) that assistants reference for factual accuracy during calls.

  6. Choose a YourCalls subscription plan

    YourCalls offers four subscription tiers based on business scale and needs:

    • Starter: Free trial for small teams to explore the platform.
    • Growth: Increased call volume limits for scaling outbound reach.
    • Professional: Higher concurrency and priority support for established teams.
    • Enterprise: Custom limits and dedicated account management for large-scale operations.

  7. Extend YourCalls assistant capabilities

    After the initial setup, you can enhance your AI assistant with the following advanced features:

    • Knowledge Base: Build a knowledge base to enable the assistant to answer factual questions.
    • Custom Tools: Integrate tools to allow the assistant to perform actions like booking appointments or updating a CRM.
    • Contact Import: Import contact lists to initiate automatic outbound call campaigns.

  8. Manage outbound campaigns via the Campaigns Dashboard

    The Campaigns Dashboard allows users to view and manage outbound calling campaigns. It is accessible at /client/campaigns. Key features include:

    • Traffic Lights: Visual status indicators (Green, Yellow, Red, Grey) on each campaign card for quick health checks.
    • Filtering: Ability to filter campaigns by Name, Assistant, Status, Time, and Days.

  10. Export a single contact's full data

    To export all data for one person, use Export everything on the contact's page. This generates a JSON file (contact-<id>.json) containing the contact details, all calls with transcripts, all chats with messages, form answers, leads, and the production timestamp.

  11. Update your user profile and password

    To manage personal account details and security, navigate to Settings > Profile in the dashboard.

    Updating Profile:

    1. Go to Settings > Profile.
    2. Update your name or email.
    3. Click Save Changes.

    Changing Password:

    1. Go to Settings > Profile.
    2. Enter your current password and the new password.
    3. Click Update Password.

  12. Trigger calls using the Fire and Forget pattern

    The POST /public/v1/calls endpoint triggers a call and returns as soon as the call is accepted. It does not wait for the call to finish, and call outcomes cannot be retrieved programmatically via the API. To handle call results, use a tool within the call itself to post results back to your system. For tracking, store the data.request_id returned by the API against your internal record to maintain a reference for support and dashboard review.
    # Trigger a call (Fire and Forget)
curl -X POST https://api.yourcalls.ai/public/v1/calls \