Call2Me

Safe summary of the connected Call2Me account: email, name, account type. NEVER returns the API key. Use when the user asks which account they are connected to.

Lists the voice assistants on the account. Use when the user wants to see their assistants, or needs to pick one for another operation.

Full settings for a single assistant: language, voice, system prompt, model.

Lists past calls: direction, duration, status, number. Pass agent_id to restrict to one assistant.

Details of a single call: start and end, duration, status, cost.

Returns the conversation transcript in vCon format — who said what, with timestamps. Use when the user asks what was said on a call.

Lists the phone numbers on the account and which assistant each one is bound to.

Lists bulk calling campaigns: status, target count, progress.

Lists scheduled calls: when, which number, which assistant.

Current account balance in USD, the same wallet that calls and numbers draw on.

Lists the live interpreters on the account: name, language pair, bound number. An interpreter connects two people who each speak their own language, translating in real time.

Settings for a single interpreter: language pair, voice, transparency mode, phone number, browser session link.

Lists sessions run through an interpreter: duration, languages, status.

Shows who is currently connected to the interpreter browser session.

Countries where a phone number can be purchased. Use before searching numbers to see which countries are open.

Lists purchasable phone numbers in a country. DOES NOT BUY — it only shows them. The country code is required; do not guess it, ask the user or call call2me_list_allowed_countries first.

Per-minute call rates and number prices.

Lists the knowledge bases (documents the assistants can search during calls). Pass agent_id to restrict to one assistant.

Details of one knowledge base: name, status and its sources.

Runs a semantic search over one knowledge base and returns the best matching passages. Use to test what an assistant would retrieve.

Lists website chat/voice widgets. Pass agent_id to restrict to one assistant.

Full widget settings plus the ready-to-paste embed code (script tag) for the user's website.

Lists text chat sessions with assistants. Pass agent_id to restrict to one assistant.

Returns one chat session with its full message history.

Details of one bulk calling campaign: status, settings and progress.

Per-contact outcomes of a campaign (answered, failed, duration).

Details of one scheduled call: time, timezone, status, recurrence.

Call statistics for one assistant (volume, duration, success) over a period.

Returns a temporary signed URL (valid about 1 hour) for a call's audio recording.

Lists available text-to-speech voices; use a voice id when creating or updating an assistant. Filter by language, provider or gender.

Lists the account's SIP trunks. Passwords are never returned.

Lists sent and received SMS messages.

Lists wallet transactions (top-ups, call charges, number fees).

Spending and usage analytics for the wallet over a period.

Shows the wallet auto top-up settings: enabled, threshold and charge amount.

Shows the account webhook URL and whether a signing secret is set. The secret itself is never returned.

Lists post-call notification targets (email, SMS, WhatsApp, webhook) of one assistant.

Creates a new voice assistant. Do not call it unless the user asks explicitly; do not invent fields such as name and language — ask.

Changes an existing assistant. Send only the fields the user named explicitly. Other API fields are accepted too, notably: knowledge_base_ids (attach knowledge bases), post_call_actions and post_call_extraction (post-call automation), voice_id, webhook_url, transfer_targets, begin_message, enable_recording.

Schedules a call for a given time. This WILL produce a REAL call — the target number is dialled when the time comes. agent_id, phone_number and scheduled_at are REQUIRED; never guess any of them, ask the user if anything is missing.

Creates a new live interpreter. name, source language and target language are REQUIRED — never guess any of them, ask the user.

Changes an existing interpreter. Send only the fields the user named explicitly.

Opens or closes the browser session link for an interpreter. Does NOT place a phone call.

Mints a single-use join passcode for the browser session.

Binds a phone number to an assistant, which then answers calls to that number. Replaces any existing binding.

Creates a checkout link for buying a number. DOES NOT BUY and DOES NOT CHARGE — the user confirms on the payment screen themselves. Use this path when the balance is insufficient.

Opens a browser voice session and returns connection details. Does NOT place a phone call.

Creates a knowledge base from text and/or URLs. To make an assistant use it, pass agent_id here (auto-links), or add the id to the assistant's knowledge_base_ids via call2me_update_agent. Provide at least one text or URL.

Adds text and/or URL sources to an existing knowledge base.

Creates a website chat widget for an assistant. Returns the embed code.

Changes widget settings. Send only the fields the user named.

Starts a text chat session with an assistant and returns session_id. Starting is free; each message sent with call2me_send_chat_message is billed.

Creates a bulk calling campaign in draft state. It does NOT call anyone until call2me_campaign_action start is used. Add contacts afterwards.

Adds contacts to a campaign from a JSON list. Numbers must be real E.164 numbers supplied by the user; never invent them.

Changes a scheduled call (time, timezone, contact name, recurrence). Send only the fields the user named.

Creates a copy of an assistant with the same settings.

Registers a SIP trunk (the user's own telephony provider). The password is stored but never returned. Calls may be routed through this server: Confirm the exact destination/value with the user first.

Registers a phone number the user already owns together with the user's own SIP trunk (trunk_id is required). Does NOT buy a number. Never invent the number. Confirm the exact destination/value with the user first.

Creates a payment link for adding credit. It does NOT pay: the user must open the link and pay. Never invent the amount; ask the user.

Sets or replaces the account webhook URL (events are POSTed there). The signing secret is never returned; supply your own webhook_secret if you need to know it, otherwise one is generated and hidden. All call events will be sent to this URL: Confirm the exact destination/value with the user first.

Adds a post-call notification (email, SMS, WhatsApp or custom URL) to an assistant. Messages will be sent to the destination after calls; never invent the destination. Confirm the exact destination/value with the user first.

Places a REAL phone call: the target number is dialled IMMEDIATELY and charged. Cannot be undone. Call this ONLY when the user explicitly asks for a call to be placed. agent_id and to_number are REQUIRED — never guess either one, never infer it from earlier conversation and never assign a default. Ask the user if anything is missing.

Cuts off a call in progress IMMEDIATELY. Cannot be undone — the conversation ends.

PERMANENTLY deletes an assistant. Cannot be undone. If it is unclear which assistant is meant, NEVER guess — ask the user.

Places a REAL phone call: the target number is dialled IMMEDIATELY, both sides are connected through live translation, and the call is charged. Cannot be undone. Call this ONLY when the user explicitly asks. interpreter_id and target_number are REQUIRED — never guess either one.

BUYS a phone number: the balance IS CHARGED and monthly rent starts. Cannot be undone. Call this ONLY when the user explicitly asks to buy and has picked the number themselves. NEVER guess the number — show options with call2me_search_numbers first and let the user choose. If the balance is insufficient, use call2me_checkout_number.

PERMANENTLY releases a phone number: it leaves the account, may be reassigned to someone else, and cannot be recovered. Incoming calls stop.

Removes the number's assistant binding; calls to it are no longer answered. The number stays on the account.

PERMANENTLY deletes an interpreter. Cannot be undone. If it is unclear which one is meant, NEVER guess — ask the user.

Cuts off the browser session in progress IMMEDIATELY. Cannot be undone.

Cancels a scheduled call. Cannot be undone.

PERMANENTLY deletes a knowledge base and its sources. Cannot be undone. Confirm with the user first; never guess which one.

PERMANENTLY deletes a widget; embedded copies stop working. Cannot be undone. Confirm with the user first.

Sends a message in a chat session and returns the assistant's reply. Each message is BILLED (about $0.01). Confirm with the user first.

Runs start, pause, resume or cancel on a campaign. START and RESUME place REAL, charged phone calls to every contact; cancel cannot be undone. Confirm with the user first and never guess the campaign.

PERMANENTLY deletes a campaign and its contacts. Cannot be undone. Confirm with the user first.

PERMANENTLY deletes a SIP trunk; numbers on it stop working. Cannot be undone. Confirm with the user first.

Sends a REAL, charged SMS. Needs the sender number (one the account owns), the recipient and the text. Never invent numbers; confirm with the user first.

Removes a post-call notification target. Cannot be undone. Confirm with the user first.