ErzyCall API
    ErzyCall API

    Getting Started

    Quick StartAuthentication

    Guides

    Rate LimitingError HandlingWebhooks

    MCP

    OverviewChat assistantsCoding toolsAutomation platformsTools & permissionsTroubleshooting

    API Reference

    OrganizationCallsContactsCasesAssistantsPhone NumbersContact GroupsUsageWebhook EndpointsWhatsApp

    Tools & permissions

    What your assistant can do once ErzyCall is connected, and what each permission grants.

    These are the actions your assistant gains. You don't need to memorise the names — describe what you want in plain language and the assistant picks the right one.

    Connected organization

    ToolWhat it does
    get_organizationShows the connected organization's ID, name, description, contact details, and profile timestamps

    Ask "Which organization am I connected to?" No organization ID is needed. This read requires organization:read; reconnect and approve the permission if your existing connection does not have it. For plan and balance details, use get_usage.

    See the organization API reference for the response fields.

    Calls

    ToolWhat it does
    create_callDial a contact using a chosen script and phone number, or an inbound agent with inboundAssistantId on a Dedicated/LiveKit number
    cancel_callCancel a call that hasn't started yet — status new or scheduled only
    list_calls, get_callOutcome, duration, transcript, recording link

    A call already dialling or connected cannot be cancelled through MCP — cancel_call returns an error once the call leaves the new / scheduled state. Hang up from the dashboard instead.

    Contacts

    ToolWhat it does
    list_contacts, search_contacts, get_contactFind people
    create_contact, update_contact, delete_contactManage people
    list_contact_groupsView groups

    WhatsApp

    ToolWhat it does
    send_whatsapp_messageSend a message
    list_whatsapp_conversations, get_whatsapp_conversationRead conversations
    list_whatsapp_accountsView connected accounts
    list_whatsapp_agentsDiscover agents across accounts, including disabled agents
    get_whatsapp_agentRead one agent's stored settings, effective defaults, and revision
    update_whatsapp_agentSave confirmed changes to a specific agent, with revision and retry protection

    Agent configuration requires fresh authorization for whatsapp_agents:read and whatsapp_agents:write. Existing WhatsApp permissions and refreshed tokens do not gain these permissions automatically. Reconnect and approve the new permissions.

    Select the exact account and agentId, read its settings, review the exact changes, then confirm the update. Supply only changed fields, the returned revision as expectedRevision, and a stable idempotencyKey. Empty optional strings and arrays clear their values. Reuse the same key, revision, and payload on retry; if the agent changed, read and review the change again. Read back after saving. Saving sends no message and applies when the runtime next loads the agent.

    See WhatsApp API reference for fields, limits, and error recovery.

    Scripts, assistants & numbers

    ToolWhat it does
    list_cases, get_case, create_case, update_case, delete_caseFind and manage call scripts
    list_outbound_assistants, get_outbound_assistant, create_outbound_assistant, update_outbound_assistant, delete_outbound_assistantOutbound assistants
    list_inbound_assistants, get_inbound_assistant, update_inbound_assistantInbound assistants
    list_phone_numbersConnected phone numbers

    Plan & usage

    ToolWhat it does
    get_usageCurrent plan, minutes left on the balance, minutes spent this period, days until it renews
    list_usage_historyEvery balance movement — call usage, renewals, top-ups, adjustments

    Things to try

    • "Make a test call to [name] and say it's a test of the ErzyCall system."
    • "How did yesterday's calls go? Which ones didn't connect?"
    • "Add Sarah Chen, +60 12 345 6789, to my contacts and tag her as a lead."
    • "Send a WhatsApp to everyone in the Warm Leads group confirming Thursday's webinar."
    • "Show me the script for the Customer Onboarding case."
    • "Is there a recording of the call with Maria?"
    • "How many minutes do I have left, and how many days until my plan renews?"
    • "What did we spend on outbound calls this month?"

    Permissions & safety

    During sign-in ErzyCall shows exactly what it's granting. The list maps to these scopes:

    PermissionWhat it allowsRisk
    organization:readView the connected organization's profile and contact detailsLow
    calls:readView calls and call resultsLow
    calls:writeCreate, schedule, and cancel callsPlaces real calls
    contacts:readView and search contactsLow
    contacts:writeCreate, update, and delete contactsChanges data
    contact_groups:readView contact groupsLow
    cases:readView call scriptsLow
    cases:writeCreate, update, and delete call scriptsChanges call behaviour
    assistants:readView assistantsLow
    assistants:writeCreate, update, and delete assistantsChanges behaviour
    phone_numbers:readView connected phone numbersLow
    whatsapp:readView WhatsApp accounts and conversationsLow
    whatsapp:writeSend WhatsApp messagesContacts real people
    whatsapp_agents:readView agent configuration, including prompts and knowledgeReads private configuration
    whatsapp_agents:writeUpdate prompts, knowledge, audience routing, and activationChanges agent behavior
    usage:readView plan, minute balance, and usage historyLow

    Calls cost money and reach real people. Keep confirmation prompts on for create_call and send_whatsapp_message until you trust the setup.

    • Test on yourself first. Add your own number as a contact and run one call end to end before pointing it at a customer list.
    • One organization at a time. The connection is bound to the org you picked at sign-in. To switch, disconnect and reconnect.
    • To revoke: remove the connector in your AI tool. There is no separate revocation screen in the ErzyCall dashboard today.

    Automation platforms

    Connect ErzyCall to n8n, Make.com, and Zapier.

    Troubleshooting

    Fixes for the failures people actually hit, plus a compatibility table.

    On this page

    Connected organizationCallsContactsWhatsAppScripts, assistants & numbersPlan & usageThings to tryPermissions & safety