> ## Documentation Index > Fetch the complete documentation index at: https://docs.famulor.io/llms.txt > Use this file to discover all available pages before exploring further. # Start outbound WhatsApp voice call > Place a WhatsApp voice call via the platform WhatsApp voice connector. **Required scope:** `calls:write`. Plan flag `whatsapp_voice` required. ## OpenAPI ````yaml /api-reference/openapi.json post /calls/whatsapp-outbound openapi: 3.1.0 info: title: Famulor API version: 1.0.0 description: >- REST API for Famulor. Authenticate with an API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a Bearer token. Every response uses a consistent envelope: `{ "data": ... , "meta": { ... } }` on success and `{ "error": { "code", "message" } }` on failure. List endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`; `meta.pagination.total` carries the total match count. REST operations require API Access through the workspace plan or a recurring add-on. Without it, regular operations return `403 api_access_required`. The invoice-payment and billing-portal operations remain available with a valid credential after a failed plan payment so an owner can recover billing. The same customer-facing capabilities are available as MCP tools at `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using the same credentials, scopes, and workspace access. MCP availability is controlled separately by Connect AI / MCP, not by API Access. servers: - url: https://app.famulor.io/api/v1 description: Hosted platform. - url: https://{domain}/api/v1 description: White-label tenant domain — same paths, tenant branding. variables: domain: default: app.famulor.io description: Your white-label tenant domain. security: - bearerAuth: [] tags: - name: Account description: Self-inspection of the calling credential. - name: Migrations description: Preview and import data from supported legacy platforms. - name: Assistants description: Create and manage voice assistants. - name: Tools description: >- Reusable tools (HTTP APIs and external MCP servers) assistants can call mid-conversation. - name: Voices description: Browse the text-to-speech voice library. - name: Calls description: Start outbound calls and read call history, transcripts and recordings. - name: History description: Unified conversation history across calls, messaging and assistant emails. - name: Campaigns description: Outbound calling campaigns with a compliant power dialer. - name: Leads description: Manage Audience contacts across campaigns, channels and Call QA metrics. - name: Segments description: >- Saved, dynamic lead filters — reusable audience definitions used for Audience search and campaign lead assignment. - name: Suppression description: Cross-channel marketing opt-outs and active workspace suppression records. - name: Callbacks description: >- Scheduled callbacks booked by the Schedule callback tool across voice, chat, and email. - name: Phone Numbers description: Marketplace numbers and customer-provided numbers. - name: Famulor Loop description: >- Personal business-phone access, directory, presence, devices, and Loop call recents. - name: SIP Trunks description: Bring your own SIP provider and numbers. - name: Carrier Connections description: Connect a supported carrier account and import its existing phone numbers. - name: Knowledge Bases description: RAG knowledge bases and documents for assistants. - name: Settings description: Workspace-level settings such as caller-memory defaults. - name: Billing description: Balance and minutes ledger of the key owner. - name: Automations description: >- Native workspace automations — list, create, update, trigger. Plan gate: automation_platform. - name: Milian Missions description: Recurring jobs that Milian runs unattended on schedule. - name: Integrations description: >- Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google Calendar, Outlook, native booking engine). Assign them to assistants to provide availability and booking tools, plus provider-supported appointment lookup, cancellation, and rescheduling. - name: Bookings description: >- Native booking engine — event types with weekly availability, public booking pages at /book/{workspace}/{slug}, and the bookings they produce. - name: Dashboards description: >- Custom analytics dashboards, reusable widgets, and tenant-scoped performance analytics. Requires the custom_dashboards plan feature. - name: Catalog description: >- Read-only platform catalogs — available models, supported assistant languages, and prompt templates. - name: Simulations description: Assistant simulation tests (plan-gated). - name: Versions description: Assistant configuration version history. - name: Caller IDs description: Outbound caller ID verification. - name: Widgets description: Web widget connectors. - name: Messaging description: >- Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK). Includes conversation delay, inactivity end, and conversation-ended webhooks. - name: QA description: Cohort AI Quality Assurance runs over call transcripts. - name: White Label description: >- Manage the customers of your white-label workspace on their behalf — list, register, mint access tokens, log in, log out, and transfer credits. Available to reseller workspaces with white-label access, and to platform admins (scoped to direct platform customers). Requires `platform:read` / `platform:write`. - name: API Keys description: >- Self-service API keys for the calling workspace or a same-brand workspace where the credential's user is owner/admin. A key can only mint further keys with a scope subset of its own. - name: Workspaces description: >- List visible workspaces, create an additional workspace for the key owner, and mint a dedicated credential for a selected owner/admin workspace. - name: SMS description: Outbound SMS from workspace phone numbers. paths: /calls/whatsapp-outbound: post: tags: - Calls summary: Start outbound WhatsApp voice call description: >- Place a WhatsApp voice call via the platform WhatsApp voice connector. **Required scope:** `calls:write`. Plan flag `whatsapp_voice` required. operationId: startWhatsAppOutboundCall requestBody: required: true content: application/json: schema: type: object required: - connector_id - to_number properties: connector_id: type: string format: uuid to_number: type: string description: E.164 WhatsApp user assistant_id: type: string format: uuid responses: '201': description: Call row created and dial started. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Call' security: - bearerAuth: [] components: schemas: Call: type: object properties: id: type: string format: uuid assistant_id: type: - string - 'null' format: uuid phone_number_id: type: - string - 'null' format: uuid direction: type: string enum: - inbound - outbound - web from_number: type: - string - 'null' to_number: type: - string - 'null' status: type: string enum: - queued - ringing - in_progress - completed - failed - no_answer - busy failure: $ref: '#/components/schemas/PublicCallFailure' description: >- Provider-neutral failure guidance. Present when a call has a normalized failure reason (telephony, billing, runtime, …). started_at: type: - string - 'null' format: date-time answered_at: type: - string - 'null' format: date-time ended_at: type: - string - 'null' format: date-time duration_sec: type: - integer - 'null' transcript: $ref: '#/components/schemas/CallTranscript' description: >- Public-safe session history. `items` contains messages and typed function_call/function_call_output entries linked by call_id. Provider metrics, request IDs and model-specific metadata are omitted. `timeline_seq`, `logical_turn_id` and `started_at` provide stable ordering when present. Null while no transcript is available. summary: type: - string - 'null' description: AI-generated post-call summary. evaluation: description: AI post-call evaluation, or `null`. analysis: type: - object - 'null' additionalProperties: true description: >- Post-call analysis result produced by the LLM judge after the call ends (only when the assistant has `analysis_config` enabled). Shape: `{ sentiment, success, success_reason, data, model, analyzed_at }`. `data` holds the structured fields defined in the assistant's `analysis_config.fields`. `null` until analysis has run. properties: sentiment: type: - string - 'null' enum: - positive - neutral - negative - null success: type: - boolean - 'null' success_reason: type: - string - 'null' data: type: object additionalProperties: true model: type: - string - 'null' analyzed_at: type: - string - 'null' format: date-time sentiment: type: - string - 'null' enum: - positive - neutral - negative - null description: >- Denormalized copy of `analysis.sentiment` for filtering. Use `?sentiment=` on `GET /calls`. success: type: - boolean - 'null' description: >- Denormalized copy of `analysis.success` for filtering. Use `?success=` on `GET /calls`. metadata: type: object additionalProperties: true description: Includes `campaign_id`/`lead_id` for campaign dialer calls. created_at: type: string format: date-time updated_at: type: string format: date-time qa_scorecard: type: - object - 'null' additionalProperties: true description: >- AI-QA scorecard result. Shape: `{ score, passed, pass_threshold, criteria[], scored_at }`. `null` until scored. qa_score: type: - number - 'null' description: Denormalized overall QA score 0–100. qa_passed: type: - boolean - 'null' description: Denormalized pass/fail against the configured threshold. required: - id - direction - status - created_at - updated_at PublicCallFailure: type: object additionalProperties: false required: - domain - code - message - retryable - action description: >- Provider-neutral failure guidance for calls. Telephony failures also set operation. properties: domain: type: string enum: - telephony - billing - admission - runtime - config - dispatch - workspace operation: type: string enum: - outbound_call - cold_transfer - warm_transfer description: Present when domain is telephony. code: type: string enum: - busy - declined - no_answer - temporarily_unavailable - cancelled_before_answer - invalid_destination - destination_not_found - authentication_failed - destination_forbidden - trunk_unavailable - no_outbound_trunk - transfer_unavailable - unknown - insufficient_credits - reservation_failed - outbound_quota_reservation_failed - integrated_outbound_limit_reached - quiet_hours - budget_service_unavailable - workspace_concurrency_limit - campaign_concurrency_limit - platform_unavailable - region_unavailable - capability_unavailable - capacity_exhausted - admission_unavailable - voice_unavailable - speech_unavailable - assistant_unavailable - call_runtime_failed - workspace_suspended - dispatch_failed - missing_destination message: type: string description: Stable, provider-neutral English explanation. retryable: type: boolean description: >- Informational retry guidance. It does not change campaign retry policy. action: type: string enum: - retry_later - do_not_retry - check_destination - check_trunk_credentials - check_trunk_configuration - connect_outbound_number - continue_call - contact_support - top_up - check_assistant - check_campaign_schedule CallTranscript: oneOf: - type: 'null' - type: object required: - items additionalProperties: false properties: items: type: array items: oneOf: - $ref: '#/components/schemas/CallTranscriptMessage' - $ref: '#/components/schemas/CallTranscriptFunctionCall' - $ref: '#/components/schemas/CallTranscriptFunctionOutput' - type: array description: Legacy role/content transcript format. items: type: object required: - role - content additionalProperties: false properties: role: type: string enum: - user - assistant content: {} CallTranscriptMessage: type: object required: - type - role - content additionalProperties: false properties: id: type: string description: Stable history item identifier. type: type: string const: message role: type: string enum: - user - assistant content: type: array items: oneOf: - type: string - type: object additionalProperties: true interrupted: type: boolean description: Whether assistant speech for this message was interrupted. timeline_seq: type: integer minimum: 1 description: Monotonic ordering key assigned when the turn started. logical_turn_id: type: string description: >- Stable turn identifier used to merge interim and final transcript updates. started_at: oneOf: - type: number description: Unix epoch seconds. - type: string format: date-time created_at: oneOf: - type: number description: Unix epoch seconds. - type: string format: date-time CallTranscriptFunctionCall: type: object required: - type - name - call_id - arguments additionalProperties: false properties: id: type: string description: Stable history item identifier. type: type: string const: function_call name: type: string call_id: type: string arguments: type: string description: JSON-encoded, public-safe tool arguments. timeline_seq: type: integer minimum: 1 description: Monotonic ordering key assigned when tool execution started. logical_turn_id: type: string description: Stable lifecycle identifier; equal to call_id for tool events. started_at: oneOf: - type: number description: Unix epoch seconds. - type: string format: date-time created_at: oneOf: - type: number description: Unix epoch seconds. - type: string format: date-time CallTranscriptFunctionOutput: type: object required: - type - name - call_id - output - is_error additionalProperties: false properties: id: type: string description: Stable history item identifier. type: type: string const: function_call_output name: type: string call_id: type: string output: type: string description: JSON-encoded or plain-text, public-safe tool result. is_error: type: boolean timeline_seq: type: integer minimum: 1 description: Monotonic ordering key assigned when tool execution ended. logical_turn_id: type: string description: Stable lifecycle identifier; equal to call_id for tool events. started_at: oneOf: - type: number description: Unix epoch seconds. - type: string format: date-time created_at: oneOf: - type: number description: Unix epoch seconds. - type: string format: date-time securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as `assistants:read`, `calls:write`, `campaigns:write`, `automations:read`, `dashboards:read`, `dashboards:write`, `leads:write`, `segments:write`, `loop:read`, `loop:write`, `phone_numbers:write`, `sip_trunks:write`, `knowledge:write`, `voices:read`, `billing:read`, `settings:write`, `platform:read`, `platform:write`; a `*:write` scope implies the matching `*:read`. Automation and dashboard endpoints also accept the legacy `calls:*` scope. Keys without scope restrictions have full access within the workspace's available capabilities. ````