accueil / serveurs / Communication / io.github.hail-hq/hail-mcp
io.github.hail-hq/hail-mcp
serveur MCP (Model Context Protocol) · hail 1.30.0
Référencé dans l'annuaire. Seul le pentest comportemental fait foi, et il n'a pas encore été exécuté sur ce serveur.
Est-ce que io.github.hail-hq/hail-mcp est sûr ?
Au dernier audit MCP Hub, le serveur MCP « io.github.hail-hq/hail-mcp » est classé « Non encore testé ». Référencé dans l'annuaire. Seul le pentest comportemental fait foi, et il n'a pas encore été exécuté sur ce serveur. Le verdict est réévalué en continu ; consultez la fiche pour l'état à jour.
Méthode : MCP Hub analyse la description de chaque outil (couche 1) et, pour le verdict fort, exécute le serveur dans une micro-VM isolée avec leurres et réseau bloqué (couche 2). On publie des noms et des compteurs, jamais le contenu brut renvoyé par un outil.
Les 38 outils
- acquire_number≈ 541 tokens
Buys a real phone number. It charges the setup fee and the first month now and renews monthly. Call quote_numbers first. Pass the offer's quote_id, country_code, number_type, and confirm_total_cents = monthly_cents + setup_cents from that offer. If the quote expired or the price changed (409) you get an error: quote again. Only buy when your user asked for this number. After buying, call route_number to point it at an agent. A quote buys at most one number. After a timeout, retry with the same quote_id and idempotency_key, or check list_numbers. Never request a new quote after a timeout. ``provider`` is ``auto`` (the quoted carrier) or the quoted carrier's name. ``idempotency_key`` is optional; to retry after a timeout or a 5xx, pass the ``idempotency_key`` that result returned, so the number is bought once. A 4xx error returns no key: the API remembers that failure under it, so drop it and quote again. Returns the number (``id``, ``e164``, ``provisioning_state``, ...) plus ``idempotency_key``, or ``{"error": "<message>", "idempotency_key": ...}``.
Paramètres, retour & exemple (6)
Paramètresprovider· string · optionnelquote_id· string · requisnumber_type· string · requiscountry_code· string · requisidempotency_key· ? · optionnelconfirm_total_cents· integer · requis
Exemple d'appel{"name": "acquire_number", "arguments": {"quote_id": "texte", "number_type": "texte", "country_code": "texte", "confirm_total_cents": 1}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - cancel_verification≈ 362 tokens
Cancel a verification that has not been sent for review, or dismiss a rejected one (needed before submitting a new one for the same country and number type). The draft is discarded. Works in state ``awaiting_review`` or ``rejected``, and for an ``approved`` US SMS registration (``purpose: "sms"``): its numbers leave the campaign, US-to-US texts from them fail again, and its monthly fee stops after the current month. Telnyx bills at least 3 monthly fees from approval, so a Telnyx registration cancelled sooner is still charged for 3 months. Ask the user first. A ``submitting`` or ``submitted`` verification is under review and cannot be cancelled (409): wait for the result with get_verification. Returns the verification with ``state: "cancelled"``, or ``{"error": "<message>"}``.
Paramètres, retour & exemple (1)
Paramètresverification_id· string · requis
Exemple d'appel{"name": "cancel_verification", "arguments": {"verification_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - confirm_verification≈ 316 tokens
When a registration shows confirmation 'code', ask the person for the code the carrier texted and submit it here. ``verification_id`` comes from submit_verification or list_verifications. ``code`` is 4 to 10 characters. A wrong or expired code is an error naming ``code``; the carrier sends a new one after a day. On success the registration moves on; poll get_verification until ``approved``. A ``confirmation`` of ``reply`` means the person answers the carrier's text instead; nothing is entered here. Returns the verification or ``{"error": "<message>"}``.
Paramètres, retour & exemple (2)
Paramètrescode· string · requisverification_id· string · requis
Exemple d'appel{"name": "confirm_verification", "arguments": {"code": "texte", "verification_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - create_agent≈ 754 tokens
Save an agent. Then call ``route_number`` so a number answers with it, or pass its id as ``agent_id`` to ``place_call``. ``system_prompt`` is what the agent follows. ``first_message`` is spoken after the AI line; omit it to let the caller speak first. ``ai_disclosure_line`` replaces the workspace AI line for this agent; ``{org}`` becomes the organization name. ``language`` is a lowercase ISO 639-1 code. ``max_duration_seconds`` is 60..3600. ``handover_max_duration_seconds`` (60..3600, default 1800) is the call limit once a handover contact answers. ``handover_contacts``: People the agent may hand a live call to: ``[{contact_id, note}]`` (max 10; ``note`` 1-200 chars says when to hand over). ``contact_id`` is an id from ``list_contacts``: a contact's uuid, or ``member:<user id>`` for a team member. The person needs a phone number. The agent never sees it. Returns the API's ``AgentResponse`` as a dict, or ``{"error": "<message>"}``.
Paramètres, retour & exemple (14)
Paramètresname· string · requistools· ? · optionnellanguage· ? · optionnelvoice_id· ? · optionnelsms_enabled· boolean · optionnelai_disclosure· boolean · optionnelfirst_message· ? · optionnelsystem_prompt· string · requisvoice_enabled· boolean · optionnelhandover_contacts· ? · optionnelrecording_enabled· ? · optionnelai_disclosure_line· ? · optionnelmax_duration_seconds· ? · optionnelhandover_max_duration_seconds· ? · optionnel
Exemple d'appel{"name": "create_agent", "arguments": {"name": "texte", "system_prompt": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - create_contact≈ 294 tokens
Save a new contact for the workspace. Provide at least one of ``phone_e164`` (E.164, e.g. ``+14155551234``) or ``email`` — the API rejects (422) a contact with neither. A duplicate phone or email on an existing contact returns 409. Example: create_contact(name="Maya Chen", phone_e164="+14155551234") Returns the created contact entry as a dict. On failure returns ``{"error": "<message>"}`` instead.
Paramètres, retour & exemple (3)
Paramètresname· string · requisemail· ? · optionnelphone_e164· ? · optionnel
Exemple d'appel{"name": "create_contact", "arguments": {"name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - delete_agent≈ 304 tokens
Delete a saved agent. DESTRUCTIVE. Ask the user before calling this. Numbers that used the agent stop answering with it: calls ring out and texts reach webhooks only. Reroute them first with ``route_number`` if that matters. ``confirm_name`` must equal the agent's ``name``. The tool reads the agent first and refuses with ``{"error": ...}`` on a mismatch, without deleting anything. To stop an agent without deleting it, use ``update_agent`` with ``status="paused"``. Returns ``{"deleted": true, "agent_id", "name"}``, or ``{"error": "<message>"}``.
Paramètres, retour & exemple (2)
Paramètresagent_id· string · requisconfirm_name· string · requis
Exemple d'appel{"name": "delete_agent", "arguments": {"agent_id": "texte", "confirm_name": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_agent≈ 208 tokens
Fetch one saved agent by id. ``agent_id`` comes from ``list_agents`` or ``create_agent``. Returns the ``AgentResponse`` as a dict (``name``, ``system_prompt``, ``first_message``, ``ai_disclosure``, ``voice_config``, ``tools``, ``voice_enabled``, ``sms_enabled``, ``status``, ...), or ``{"error": "<message>"}``.
Paramètres, retour & exemple (1)
Paramètresagent_id· string · requis
Exemple d'appel{"name": "get_agent", "arguments": {"agent_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_call≈ 194 tokens
Fetch the current state of one call by id. Use this after ``place_call`` (or to check on any prior call) to read the call's latest ``status`` and timing fields. Returns the API's ``CallResponse`` as a dict, or ``{"error": "call not found"}`` for an unknown id.
Paramètres, retour & exemple (1)
Paramètrescall_id· string · requis
Exemple d'appel{"name": "get_call", "arguments": {"call_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_email≈ 237 tokens
Fetch the full record of one email by id. Returns the complete row — including ``body_text`` / ``body_html`` and (for inbound mail) the ``in_reply_to`` / ``message_id`` headers and ``spam``/``virus``/``spf``/``dkim``/``dmarc`` verdicts. Use this after ``list_emails`` to read a received reply's body. Returns the API's ``EmailResponse`` as a dict, or ``{"error": "resource not found"}`` for an unknown id.
Paramètres, retour & exemple (1)
Paramètresemail_id· string · requis
Exemple d'appel{"name": "get_email", "arguments": {"email_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_email_attachment≈ 250 tokens
Get a fetchable URL for one inbound email attachment. ``attachment_id`` comes from an item in ``get_email``'s ``attachments`` list. Returns ``{"url": "<presigned-s3-url>"}`` — a short-lived (~5 minute) link to the attachment bytes, fetchable directly with no auth header. Unknown ids return ``{"error": "resource not found"}``.
Paramètres, retour & exemple (2)
Paramètresemail_id· string · requisattachment_id· string · requis
Exemple d'appel{"name": "get_email_attachment", "arguments": {"email_id": "texte", "attachment_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_email_events≈ 412 tokens
Delivery/engagement timeline (sent→delivered→opened…) for one email. Chronological lifecycle events for a single email — use this to see exactly what happened to one message (bounced? opened? clicked?) rather than the account-wide aggregates ``get_email_stats`` returns. Returns ``{"items": [...], "next_cursor": ...}`` where each item has ``kind`` (one of sent, delivered, delivery_delayed, bounced, complained, rejected, opened, clicked), ``payload``, and ``occurred_at``. ``opened`` and ``clicked`` only occur for emails sent with an HTML body. A plain-text-only email still gets sent, delivered, and bounce events, but opens and clicks are never tracked. Pass ``cursor`` from a previous ``next_cursor`` to page (``limit`` 1..1000, default 100). On failure returns ``{"error": "resource not found"}`` for an unknown id.
Paramètres, retour & exemple (3)
Paramètreslimit· ? · optionnelcursor· ? · optionnelemail_id· string · requis
Exemple d'appel{"name": "get_email_events", "arguments": {"email_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_email_raw≈ 224 tokens
Get a fetchable URL for an email's original MIME source. Returns ``{"url": "<presigned-s3-url>"}`` — a short-lived (~5 minute) link to the full raw RFC822 message. Fetch the URL directly to read the complete original; it needs no auth header. Raw source exists for **inbound** mail only — outbound ids return ``{"error": "resource not found"}``.
Paramètres, retour & exemple (1)
Paramètresemail_id· string · requis
Exemple d'appel{"name": "get_email_raw", "arguments": {"email_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_email_stats≈ 448 tokens
Account-level email deliverability stats (counts, rates, time series). Aggregates across your whole organization's outbound mail over a window — use this for "how's deliverability doing" rather than one message's history (``get_email_events`` covers that). ``from_`` / ``to`` are ISO 8601 timestamps (defaults: last 7 days ending now). ``bucket`` is ``"day"`` (default) or ``"hour"`` — ``"hour"`` is limited to an 8-day span; any range is capped at 92 days. Returns ``{"from": ..., "to": ..., "bucket": ..., "totals": {...}, "rates": {...}, "series": [...]}`` — ``totals``/each ``series`` bucket carry counts (sent, delivered, bounced, opened, ...) and ``rates`` carries derived ratios (delivery, bounce, open, click), each ``None`` when ``totals.sent`` is 0. Open and click numbers only count HTML emails. Plain-text-only emails are never tracked for opens or clicks, so they lower those rates. On failure returns ``{"error": "<message>"}`` instead.
Paramètres, retour & exemple (3)
Paramètresto· ? · optionnelfrom_· ? · optionnelbucket· string · optionnel
Exemple d'appel{"name": "get_email_stats", "arguments": {"to": "texte", "from_": "texte", "bucket": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_events≈ 514 tokens
Page through events from across the org or one resource. Pass ``id="<type>:<uuid>"`` to narrow to a single resource — supported types are ``call``, ``email``, and ``sms`` (e.g. ``id="sms:<uuid>"`` after ``send_sms``). When narrowed to a call, the response includes a ``call_status`` field reflecting the call's current state. Without ``id``, returns events from across the whole org. ``kind`` filters server-side by event kind (``state_change``, ``agent_turn``, ``user_turn``, ``tool_call``, ``error``, ...). This is **not** a streaming subscription — the call returns whatever events exist now plus a ``next_cursor`` if more pages remain. To follow a call to completion, loop: pass the previous response's ``next_cursor`` until ``next_cursor`` is null and, when narrowed to a call, ``call_status`` is one of ``completed``, ``failed``, ``busy``, ``no_answer``, ``canceled`` (the terminal set). Example: get_events(id="call:0c2f...-...", limit=200) Returns ``{"items": [...], "next_cursor": <str|None>, "call_status": <str|None>}`` on success, or ``{"error": ...}`` on a malformed ``id`` or upstream failure.
Paramètres, retour & exemple (4)
Paramètresid· ? · optionnelkind· ? · optionnellimit· integer · optionnelcursor· ? · optionnel
Exemple d'appel{"name": "get_events", "arguments": {"id": "texte", "kind": "texte", "limit": 1, "cursor": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_number≈ 186 tokens
Fetch one dedicated number by id: its state, capabilities and which agents answer its calls and texts. ``number_id`` comes from ``list_numbers``. Returns the ``PhoneNumberResponse`` as a dict, or ``{"error": "<message>"}``.
Paramètres, retour & exemple (1)
Paramètresnumber_id· string · requis
Exemple d'appel{"name": "get_number", "arguments": {"number_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_sms≈ 161 tokens
Fetch the current state of one SMS by id. Use this after ``send_sms`` to check delivery status. Example: get_sms(sms_id="...")
Paramètres, retour & exemple (1)
Paramètressms_id· string · requis
Exemple d'appel{"name": "get_sms", "arguments": {"sms_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_verification≈ 306 tokens
Fetch one verification and its state. Use it to poll. There is no notification, and review takes business days. Poll every few minutes to hours, not every few seconds; the state refreshes from the carrier at most once a minute. On ``approved``: call quote_numbers again. The offer is now ``ready``; then acquire_number. On ``rejected``: read ``rejection_reason``, ask the user, dismiss it with cancel_verification, then submit a new one. ``verification_id`` comes from submit_verification or list_verifications. Returns ``{"id", "state", "rejection_reason", ...}`` or ``{"error": "<message>"}``.
Paramètres, retour & exemple (1)
Paramètresverification_id· string · requis
Exemple d'appel{"name": "get_verification", "arguments": {"verification_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_verification_requirements≈ 558 tokens
Read what the carrier needs to verify the organization before it can buy a number. Call this when quote_numbers shows an offer with ``readiness == "verification_required"``. Read-only. ``country_code`` is ISO alpha-2 (for example ``"GB"``). ``number_type`` is ``local``, ``mobile``, ``national`` or ``toll_free``. ``subject_type`` is ``person`` (default) or ``business``; the result's ``subject_types`` lists what the carrier accepts. ``provider`` is optional. ``purpose`` is ``number`` (default, to buy a number) or ``sms``. ``purpose='sms'`` registers the organization to text US numbers from a US number (country_code US, number_type local). The carrier fee is debited from credit at filing. Returns ``required`` (false means no verification is needed and submit_verification would fail), ``fields`` (values to collect), ``documents`` (slots, each with ``options``), ``address_required``. Skip any document slot whose ``needs_input`` is false: do not send it. Ask the USER for every value and every file. Never invent, guess or infer personal or company data. Never reuse data from another task. Errors come back as ``{"error": "<message>"}``.
Paramètres, retour & exemple (5)
Paramètrespurpose· string · optionnelprovider· ? · optionnelnumber_type· string · requiscountry_code· string · requissubject_type· string · optionnel
Exemple d'appel{"name": "get_verification_requirements", "arguments": {"number_type": "texte", "country_code": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list_agents≈ 224 tokens
List the workspace's saved agents: the brains that answer calls and texts on its numbers, and that ``place_call`` can use via ``agent_id``. Returns ``{"items": [{"id", "name", "system_prompt", "first_message", "ai_disclosure", "ai_disclosure_line", "voice_config", "tools", "max_duration_seconds", "handover_max_duration_seconds", "voice_enabled", "sms_enabled", "status", "handover_contacts"}, ...]}``.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "list_agents", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list_calls≈ 290 tokens
List recent calls in your organization, newest first. Cursor-paginated: pass the previous response's ``next_cursor`` to fetch the next page. ``status`` (one of queued, dialing, ringing, in_progress, completed, failed, busy, no_answer, canceled) and ``to`` (E.164) are optional server-side filters. Returns a dict ``{"items": [...], "next_cursor": <str|None>}``.
Paramètres, retour & exemple (4)
Paramètresto· ? · optionnellimit· integer · optionnelcursor· ? · optionnelstatus· ? · optionnel
Exemple d'appel{"name": "list_calls", "arguments": {"to": "texte", "limit": 1, "cursor": "texte", "status": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list_contacts≈ 288 tokens
List the workspace's contacts: org members (with their phone/email) plus manually saved contacts. Use ``lookup_contact`` for name searches. ``q`` optionally filters server-side (matches name/email/phone). ``limit`` caps the page (server default 100, max 500). Returns ``{"items": [{"id", "kind", "name", "phone_e164", "email", "role"}, ...]}`` — ``kind`` is ``"member"`` (id ``member:<user_id>``, ``role`` set) or ``"manual"`` (id is the contact's UUID, ``role`` null).
Paramètres, retour & exemple (2)
Paramètresq· ? · optionnellimit· ? · optionnel
Exemple d'appel{"name": "list_contacts", "arguments": {"q": "texte", "limit": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list_email_domains≈ 394 tokens
List the addresses this workspace can send email from. Call this BEFORE ``send_email`` when you do not already know the ``from_`` address — do not guess a domain. Returns ``{"items": [...], "next_cursor": ..., "default_from": ...}``. Each item carries ``domain``, ``kind`` (``"custom"`` or ``"hail_mail"``) and ``verification_status``; only ``"verified"`` rows can send. A ``custom`` item's ``domain`` is a bare DNS name that accepts any local-part (``sales@acme.com``); a ``hail_mail`` item's ``domain`` is already a full address. ``default_from`` is the address a ``send_email`` with no ``from_`` goes out as. It is null when the workspace has several verified identities — then ``send_email`` rejects a missing ``from_`` and you must pass one from ``items``. Example: list_email_domains()
Paramètres, retour & exemple (2)
Paramètreslimit· ? · optionnelcursor· ? · optionnel
Exemple d'appel{"name": "list_email_domains", "arguments": {"limit": "texte", "cursor": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list_emails≈ 387 tokens
List emails in your organization, newest first. Cursor-paginated: pass the previous response's ``next_cursor`` to fetch the next page. Two optional server-side filters: * ``direction`` — ``outbound`` or ``inbound``. Pass ``direction="inbound"`` to read replies and other received mail. * ``status`` — one of ``queued``, ``sent``, ``failed``, ``bounced``, ``complained``, ``received``. Items are trimmed summaries (no message body). Call ``get_email`` with an item's ``id`` to read the full body. Example: list_emails(direction="inbound") Returns ``{"items": [...], "next_cursor": <str|None>}`` on success, or ``{"error": "<message>"}`` instead.
Paramètres, retour & exemple (4)
Paramètreslimit· integer · optionnelcursor· ? · optionnelstatus· ? · optionneldirection· ? · optionnel
Exemple d'appel{"name": "list_emails", "arguments": {"limit": 1, "cursor": "texte", "status": "texte", "direction": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list_number_regions≈ 197 tokens
List the US state and Canadian province codes that quote_numbers accepts as ``region`` (optional, with ``city``). Returns ``{"regions": [{"country_code", "code", "name"}]}``, such as ``{"country_code": "US", "code": "AZ", "name": "Arizona"}``, or ``{"error": "<message>"}``.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "list_number_regions", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list_numbers≈ 251 tokens
List the workspace's dedicated phone numbers, newest first. ``limit`` is 1..200 (default 50). Pass the returned ``next_cursor`` as ``cursor`` for the next page. Returns ``{"items": [{"id", "e164", "provider", "country_code", "number_type", "capabilities", "provisioning_state", "voice_agent_id", "sms_agent_id", ...}], "next_cursor"}``, or ``{"error": "<message>"}``.
Paramètres, retour & exemple (2)
Paramètreslimit· integer · optionnelcursor· ? · optionnel
Exemple d'appel{"name": "list_numbers", "arguments": {"limit": 1, "cursor": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list_sms≈ 260 tokens
Page through recent SMS messages for your organization. ``status`` filters to one of: queued, sent, delivered, failed, undelivered, received. ``to`` filters to messages sent to a specific E.164 number. Paginate with the returned ``next_cursor``.
Paramètres, retour & exemple (4)
Paramètresto· ? · optionnellimit· integer · optionnelcursor· ? · optionnelstatus· ? · optionnel
Exemple d'appel{"name": "list_sms", "arguments": {"to": "texte", "limit": 1, "cursor": "texte", "status": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list_verifications≈ 363 tokens
List the organization's carrier verifications, newest first. ``purpose`` is ``number`` or ``sms``; only that kind is listed. Omit to see every registration. ``purpose='sms'`` lists the registrations to text US numbers from a US number. Returns ``{"items": [{"id", "provider", "country_code", "number_type", "subject_type", "purpose", "state", "rejection_reason", "created_at", "updated_at", "submitted_at", "approved_at", "confirmation"}]}``. ``state`` is ``awaiting_review``, ``submitting``, ``submitted``, ``approved``, ``rejected`` or ``cancelled``. Use it to check whether a submission already exists before submitting again. ``confirmation`` ``code``: call confirm_verification with the code the carrier texted the person. Errors come back as ``{"error": "<message>"}``.
Paramètres, retour & exemple (1)
Paramètrespurpose· ? · optionnel
Exemple d'appel{"name": "list_verifications", "arguments": {"purpose": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - lookup_contact≈ 213 tokens
Find a contact by name, email, or phone fragment. Resolve a person to their ``phone_e164``/``email`` BEFORE calling ``place_call``, ``send_sms``, or ``send_email`` — do not guess a contact's number. Returns up to 10 matches, same item shape as ``list_contacts``. Example: lookup_contact(query="maya")
Paramètres, retour & exemple (1)
Paramètresquery· string · requis
Exemple d'appel{"name": "lookup_contact", "arguments": {"query": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - place_call≈ 1388 tokens
Originate an outbound phone call. Provide ``system_prompt`` (mode A — Hail's bundled fallback LLM uses this prompt) or ``llm`` (mode B — bring your own OpenAI-compatible endpoint as ``{"base_url": ..., "api_key": ..., "model": ...}``), or both, or ``agent_id`` (a saved agent from ``list_agents`` supplies the prompt, first message, AI line, voice and tools; fields you pass here win). At least one is required. Passing both runs your prompt on your own endpoint: it receives Hail's voice preamble plus your prompt as the leading system message. ``to`` must be E.164 (e.g. ``+14155551234``). ``from_`` is optional and defaults to the first active number on your org. ``first_message`` is spoken verbatim on pickup; omit it to let the agent open the conversation itself — it reacts to how the call was answered, or introduces itself after silence. ``language`` sets the call's spoken language for speech-to-text, text-to-speech, and turn detection, as a lowercase ISO 639-1 code (e.g. ``"da"``); 39 languages are supported (server rejects others with 422); omit for English. STT provider selection is console-BYO-only (no per-call override); configure it on the organization to pin a provider. ``ai_disclosure=False`` skips the spoken "this is an AI assistant" line at the start of the call. Leave enabled unless the user has verified it is not required for this call — US artificial-voice calls (47 CFR 64.1200(b)(1)) and several AI bot-disclosure laws require it, and Hail does not verify this. The agent still identifies itself as an AI if asked. ``metadata`` is free-form JSON attached to the call record. ``tools`` are the agent tools to allow on this call. Omit for all available; pass ``[]`` to disable. ``recipient_consent`` is required and must be the JSON boolean ``true`` (strings and numbers are refused): attest that you (the caller triggering this request) have obtained the lawful consent needed to contact this recipient. The API rejects the request (422) if this is not ``true`` — Hail does not verify consent for you, you are responsible for having a lawful basis (TCPA / ePrivacy / GDPR as applicable). Set ``message_type="marketing"`` for promotional calls (this additionally requires a non-empty ``consent_source`` describing how/where consent was obtained) — leave as the default ``"informational"`` for transactional/service calls. ``idempotency_key`` defaults to a fresh UUID per invocation and is returned in the response under ``idempotency_key`` — to retry *this* exact request (rather than dispatch a second call), pass the value back on the retry. A new key is a new call. Example: place_call(to="+14155551234", recipient_consent=True, system_prompt="You are scheduling a haircut.", first_message="Hi, I'm calling on behalf of Alex.") Returns the API's ``CallResponse`` as a dict (id, status, from_e164, to_e164, ...). On failure returns ``{"error": "<message>"}`` instead.
Paramètres, retour & exemple (16)
Paramètresto· string · requisllm· ? · optionnelfrom_· ? · optionneltools· ? · optionnelagent_id· ? · optionnellanguage· ? · optionnelmetadata· ? · optionnelmessage_type· string · optionnelai_disclosure· boolean · optionnelfirst_message· ? · optionnelsystem_prompt· ? · optionnelconsent_source· ? · optionnelidempotency_key· ? · optionnelrecipient_consent· boolean · requisrecording_enabled· ? · optionnelconsent_obtained_at· ? · optionnel
Exemple d'appel{"name": "place_call", "arguments": {"to": "texte", "recipient_consent": true}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - quote_numbers≈ 770 tokens
Compare live phone-number offers from the carriers. Read-only: it buys nothing and charges nothing. ``country_code`` is an ISO alpha-2 code such as ``"US"``. ``capabilities`` is ``["voice"]``, ``["sms"]`` or both (default). ``number_type`` is ``local``, ``mobile``, ``national`` or ``toll_free``; omit it to compare all types. ``provider`` is ``auto`` (compare all carriers), ``twilio``, ``telnyx`` or ``didww``. ``area_code`` is an area code or the first digits of the number, as dialed in the country: ``"020"`` (London), ``"480"`` (Arizona). ``city`` is a city name such as ``"London"``. Each offer has ``locality`` and ``region`` (such as ``"Phoenix"``, ``"AZ"``): check them, since city names repeat across states. ``region`` (optional, with ``city``) is a US/CA state code; list_number_regions lists them. Omit all three to search the whole country. Returns ``{"offers": [...], "recommended_quote_id", "unavailable_providers", "expires_at"}``. Each offer has ``e164``, ``provider``, ``number_type``, ``capabilities``, ``monthly_cents``, ``setup_cents``, ``readiness``, ``requirements`` and ``quote_id``. Money fields are cents (USD). Quotes expire in 10 minutes (``expires_at``); quote again after that. An offer with ``readiness == "verification_required"`` cannot be bought until the organization is verified. Call get_verification_requirements, ask the user for the details, then submit_verification and poll get_verification (review takes business days). ``requirements`` lists what the carrier needs. Prefer an offer whose ``readiness`` is ``"ready"``; ``recommended_quote_id`` points at the best one, or is null if none is ready. Errors come back as ``{"error": "<message>"}``.
Paramètres, retour & exemple (7)
Paramètrescity· ? · optionnelregion· ? · optionnelprovider· string · optionnelarea_code· ? · optionnelnumber_type· ? · optionnelcapabilities· ? · optionnelcountry_code· string · requis
Exemple d'appel{"name": "quote_numbers", "arguments": {"country_code": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - release_number≈ 356 tokens
Release a phone number. DESTRUCTIVE and permanent. Calls and texts to the number stop. This month's fee and any earlier months are still billed. There is no refund. The number may not be recoverable. Ask the user before calling this. ``confirm_e164`` must equal the number's ``e164`` (for example ``"+14155550100"``). The tool reads the number first and refuses with ``{"error": ...}`` on a mismatch, without releasing anything. A number whose order is still pending cannot be released (409). A number whose order failed was never bought: the call only hides it from the list and returns ``{"dismissed": true, "number_id", "e164"}``. Returns ``{"released": true, "number_id", "e164"}``, or ``{"error": "<message>"}``.
Paramètres, retour & exemple (2)
Paramètresnumber_id· string · requisconfirm_e164· string · requis
Exemple d'appel{"name": "release_number", "arguments": {"number_id": "texte", "confirm_e164": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - route_number≈ 358 tokens
Choose which agent answers a number's calls and texts. ``voice_agent_id`` makes the number answer calls with that agent (Hail registers it for inbound at the carrier and LiveKit); ``clear_voice=True`` stops answering calls. ``sms_agent_id`` makes the agent reply to texts; ``clear_sms=True`` stops that. A field left out keeps its value. ``number_id`` comes from GET /numbers. Returns the updated ``PhoneNumberResponse`` as a dict, or ``{"error": "<message>"}``.
Paramètres, retour & exemple (5)
Paramètresclear_sms· boolean · optionnelnumber_id· string · requisclear_voice· boolean · optionnelsms_agent_id· ? · optionnelvoice_agent_id· ? · optionnel
Exemple d'appel{"name": "route_number", "arguments": {"number_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - send_email≈ 1330 tokens
Send an outbound email through your configured SES sender. ``to`` is a non-empty list of RFC-style email addresses. At least one of ``body_text`` / ``body_html`` is required (both is fine — multipart-alternative). Prefer including ``body_html``: open and click tracking only works for emails with an HTML body. A plain-text-only email still gets sent, delivered, and bounce events, but opens and clicks are never tracked. ``cc``, ``bcc``, and ``reply_to`` are optional and follow the usual mail conventions. Hail sets no ``reply_to`` of its own — to have replies reach the human running this session, call ``whoami`` and pass their ``email``. ``recipient_consent`` is required and must be the JSON boolean ``true`` (strings and numbers are refused): attest that you (the caller triggering this request) have obtained the lawful consent needed to email this recipient. The API rejects the request (422) if this is not ``true`` — Hail does not verify consent for you. Set ``message_type="marketing"`` for promotional email (this additionally requires a non-empty ``consent_source`` describing how/where consent was obtained) — leave as the default ``"informational"`` for transactional/service email. ``from_`` is optional only while the workspace has one verified sender identity. With several, omitting it returns 422 listing them — call ``list_email_domains`` and pass one. With none, the server auto-mints a per-org hail-mail address of the form ``<user>+<org>@<base>`` if the operator configured ``HAIL_MAIL_BASE_DOMAIN`` (the ``<org>`` part is derived from your organization id; the ``<user>`` part comes from ``HAIL_MAIL_FROM`` / ``HAIL_MAIL_DEFAULT_USER_PREFIX``, or an explicit row created via ``POST /email-domains``). When supplied, ``from_`` must match a verified row already in ``email_domains`` (register one with the website console or ``POST /email-domains``). ``from_name`` is an optional display name rendered on the From: header ("Acme Billing <billing@acme.com>"). Control characters are rejected. ``metadata`` is free-form JSON attached to the email record. ``idempotency_key`` defaults to a fresh UUID and is returned in the response under ``idempotency_key`` — pass the same value on a retry to replay rather than re-send. A new key is a new message. ``attachment_ids`` are ids returned by ``upload_email_attachment`` — upload a file first, then pass its id(s) here to attach it. Example: send_email(to=["alice@example.com"], subject="Welcome", recipient_consent=True, body_text="Thanks for signing up.") Returns the ``EmailResponse`` dict (id, status, from_address, to_addresses, sent_at, provider_message_id, ...). On failure returns ``{"error": "<message>"}`` instead.
Paramètres, retour & exemple (16)
Paramètrescc· ? · optionnelto· array · requisbcc· ? · optionnelfrom_· ? · optionnelsubject· string · requismetadata· ? · optionnelreply_to· ? · optionnelbody_html· ? · optionnelbody_text· ? · optionnelfrom_name· ? · optionnelmessage_type· string · optionnelattachment_ids· ? · optionnelconsent_source· ? · optionnelidempotency_key· ? · optionnelrecipient_consent· boolean · requisconsent_obtained_at· ? · optionnel
Exemple d'appel{"name": "send_email", "arguments": {"to": [], "subject": "texte", "recipient_consent": true}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - send_sms≈ 775 tokens
Send an outbound SMS. ``to`` must be E.164 (e.g. ``+14155551234``). ``body`` is the message text. With no ``from_``: destinations where the sender-ID carrier delivers a dynamic alphanumeric sender ID unchanged (about 110 countries, see core/hailhq/core/sender_id_corridors.py) use your organization's sender ID (or ``HAIL``, the platform default); Australia (+61) always uses ``HAIL`` when that carrier is Twilio; every other destination, including the US and Canada, uses your organization's oldest active SMS-capable number and the API returns 422 when there is none. SMS never uses the shared voice-call pool. ``recipient_consent`` is required and must be the JSON boolean ``true`` (strings and numbers are refused): attest that you (the caller triggering this request) have obtained the lawful consent needed to text this recipient. The API rejects the request (422) if this is not ``true`` — Hail does not verify consent for you. Set ``message_type="marketing"`` for promotional texts (this additionally requires a non-empty ``consent_source``) — leave as the default ``"informational"`` for transactional/service texts. ``idempotency_key`` defaults to a fresh UUID and is returned in the response under ``idempotency_key`` — pass the same value on a retry to replay rather than re-send. Example: send_sms(to="+14155551234", body="Your order shipped!", recipient_consent=True) Returns the ``SmsResponse`` dict (id, status, from_e164, to_e164, segment_count, ...). On failure returns ``{"error": "<message>"}`` instead.
Paramètres, retour & exemple (9)
Paramètresto· string · requisbody· string · requisfrom_· ? · optionnelmetadata· ? · optionnelmessage_type· string · optionnelconsent_source· ? · optionnelidempotency_key· ? · optionnelrecipient_consent· boolean · requisconsent_obtained_at· ? · optionnel
Exemple d'appel{"name": "send_sms", "arguments": {"to": "texte", "body": "texte", "recipient_consent": true}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - submit_verification≈ 917 tokens
Send the user's personal or company details and identity documents to the carrier for verification. IRREVERSIBLE: once submitted it cannot be cancelled, and the carrier keeps the documents. ``attest_authorized``: pass true only if the person or company named in these details and documents asked for this submission and gave you the details and files in this conversation. Never invent, guess, infer or reuse personal data or documents. Anything else: pass false (the call then sends nothing). ``purpose`` is ``number`` (default) or ``sms``. ``purpose='sms'`` registers the organization to text US numbers from a US number (country_code US, number_type local). The carrier fee is debited from credit at filing. Pass the same ``purpose`` to get_verification_requirements. Steps: 1) call get_verification_requirements. 2) Ask the user for each field and file. 3) Call this once. Do not submit twice: a 409 means one already exists (see list_verifications). Arguments, as listed by get_verification_requirements: ``fields`` is ``{field name: value}``. ``address`` is ``{"customer_name", "street", "city", "region", "postal_code", "country_code"}`` (all required when ``address_required``). ``documents`` is ``{slot: {"option": <option key>, "fields": {...}}}`` for each slot with ``needs_input``. ``files`` is a list of ``{"slot", "content_type", "content_base64"}``, one per slot that needs a file; ``slot`` must be a key in ``documents`` and match letters, digits, - and _ (at most 64). ``content_type`` is ``image/jpeg``, ``image/png`` or ``application/pdf``. Limits: 10 MiB per file, 29 MiB in total, at most 20 files and 20 fields. Compress images to JPG or PNG under about 7 MiB so the call stays small. Returns the verification: ``id`` and ``state`` (no personal data). Review takes business days and nothing notifies you: poll get_verification. If the carrier finds a problem you get ``{"error", "problems": [{"loc", "msg"}]}`` and nothing is stored: ask the user to fix it, then submit again. After a timeout call list_verifications before trying again.
Paramètres, retour & exemple (10)
Paramètresfiles· array · requisfields· object · requisaddress· ? · optionnelpurpose· string · optionnelprovider· ? · optionneldocuments· object · requisnumber_type· string · requiscountry_code· string · requissubject_type· string · optionnelattest_authorized· boolean · requis
Exemple d'appel{"name": "submit_verification", "arguments": {"files": [], "fields": {}, "documents": {}, "number_type": "texte", "country_code": "texte", "attest_authorized": true}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - update_agent≈ 908 tokens
Change a saved agent. Safe to repeat: the same call gives the same result. Only the fields you pass change; a field left out keeps its value. ``status`` is ``"live"`` or ``"paused"``; a paused agent does not answer. ``language`` is a lowercase ISO 639-1 code. Pass ``language`` or ``voice_id`` alone: the other value is kept. ``max_duration_seconds`` and ``handover_max_duration_seconds`` are 60..3600. ``handover_contacts`` replaces the whole list: ``[{contact_id, note}]`` (max 10) as in ``create_agent``; ``[]`` removes every contact. To remove a value, list its name in ``clear_fields``. Allowed: ``first_message`` (the agent waits for the caller), ``ai_disclosure_line`` (back to the workspace line), ``tools`` (back to all tools), ``max_duration_seconds`` (back to the workspace limit), ``handover_max_duration_seconds`` (back to 1800). Any other name is refused. Do not set and clear one field. Live calls keep the settings they started with. The change applies to the next call or text. Returns the updated ``AgentResponse`` as a dict, or ``{"error": "<message>"}``.
Paramètres, retour & exemple (17)
Paramètresname· ? · optionneltools· ? · optionnelstatus· ? · optionnelagent_id· string · requislanguage· ? · optionnelvoice_id· ? · optionnelsms_enabled· ? · optionnelclear_fields· ? · optionnelai_disclosure· ? · optionnelfirst_message· ? · optionnelsystem_prompt· ? · optionnelvoice_enabled· ? · optionnelhandover_contacts· ? · optionnelrecording_enabled· ? · optionnelai_disclosure_line· ? · optionnelmax_duration_seconds· ? · optionnelhandover_max_duration_seconds· ? · optionnel
Exemple d'appel{"name": "update_agent", "arguments": {"agent_id": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - upload_email_attachment≈ 321 tokens
Upload a file to attach to a future outbound email. ``content_base64`` is the file's raw bytes, base64-encoded. Returns ``{"id": ..., "filename": ..., "content_type": ..., "size_bytes": ...}`` — pass ``id`` in ``send_email``'s ``attachment_ids`` list. The id is reusable across many sends and expires in 24h if never used. Files over 25MB (combined with the message body and any other attachments, per send) are rejected — host large files externally and link to them in the body instead.
Paramètres, retour & exemple (3)
Paramètresfilename· string · requiscontent_type· string · requiscontent_base64· string · requis
Exemple d'appel{"name": "upload_email_attachment", "arguments": {"filename": "texte", "content_type": "texte", "content_base64": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - whoami≈ 253 tokens
Identify the human whose credentials this session runs under. Use it to sign or route mail as that person: pass their address as ``send_email(reply_to=...)`` so replies reach them rather than the sending domain, which is often an unattended ``noreply@``. Returns ``{"auth_kind", "organization_id", "user_id", "email", "name"}``. ``user_id``/``email``/``name`` are null when the server runs on a shared operator key (``auth_kind="shared"``) — there is no human behind it, so send without a ``reply_to``. Example: whoami()
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "whoami", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}]}
C'est votre serveur ?
Revendiquez-le sur l'espace créateur (preuve GitHub, domaine ou npm) pour afficher le badge « propriétaire vérifié » et lancer un pentest comportemental à la demande afin d'obtenir le badge « Vérifié ».