> ## 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. # Estimate assistant or Loop phone rates > List available countries or estimate incoming or outgoing assistant or Loop phone rates for the current workspace. Loop requires calls:read or loop:read; assistant estimates require calls:read. Omit country to list supported countries. Assistant estimates cover purchased numbers and verified caller IDs using the included phone service. Your own connected phone service is billed separately. Amounts are EUR equivalents at the current credit top-up rate, not a guaranteed invoice total. Country ranges cover available number types and destination networks. Transfers can involve multiple call legs; Loop conference participation, recording and queue handling can add separate usage. AI assistant talk time is separate. Final charges are calculated after the call ends. ## OpenAPI ````yaml /api-reference/openapi.json get /usage/telephony-rates 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 `billing:write` credential after a failed plan payment so an authorized owner, admin, or billing member 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 white-label customer accounts, defaults, credit transfers and customer plan offers. Each endpoint documents its required scope and workspace eligibility. - 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: /usage/telephony-rates: get: tags: - Billing summary: Estimate assistant or Loop phone rates description: >- List available countries or estimate incoming or outgoing assistant or Loop phone rates for the current workspace. Loop requires calls:read or loop:read; assistant estimates require calls:read. Omit country to list supported countries. Assistant estimates cover purchased numbers and verified caller IDs using the included phone service. Your own connected phone service is billed separately. Amounts are EUR equivalents at the current credit top-up rate, not a guaranteed invoice total. Country ranges cover available number types and destination networks. Transfers can involve multiple call legs; Loop conference participation, recording and queue handling can add separate usage. AI assistant talk time is separate. Final charges are calculated after the call ends. operationId: getTelephonyUsageRates parameters: - name: context in: query required: false description: Choose assistant phone service or Loop calling. schema: type: string enum: - loop - assistant default: loop - name: country in: query required: false description: >- Two-letter country code. Incoming: receiving number country. Outgoing: destination country. Omit for the country list. schema: type: string pattern: ^[A-Za-z]{2}$ - name: direction in: query required: false schema: type: string enum: - inbound - outbound default: outbound responses: '200': description: Available countries or workspace-specific estimates. content: application/json: schema: type: object required: - data properties: data: oneOf: - type: object required: - countries properties: countries: type: array items: type: object required: - code - name properties: code: type: string pattern: ^[A-Z]{2}$ name: type: string - type: object required: - context - country - direction - currency - estimated - updated_at - amount_basis - rates - unavailable_categories - finalized_after_call properties: context: type: string enum: - loop - assistant country: type: string pattern: ^[A-Z]{2}$ direction: type: string enum: - inbound - outbound currency: type: string enum: - EUR estimated: type: boolean enum: - true updated_at: type: string format: date-time amount_basis: type: string enum: - topup_credit_value rates: type: array items: type: object required: - category - unit - min_credits - max_credits - min_amount - max_amount properties: category: type: string enum: - phone - browser - sip - conference - queue - queue_waiting - recording - whatsapp_voice unit: type: string enum: - minute - participant_minute - task min_credits: type: number minimum: 0 max_credits: type: number minimum: 0 min_amount: type: number minimum: 0 description: >- EUR equivalent at the current workspace credit top-up rate, in major units. max_amount: type: number minimum: 0 description: >- EUR equivalent at the current workspace credit top-up rate, in major units. unavailable_categories: type: array items: type: string enum: - phone - browser - sip - conference - queue - queue_waiting - recording - whatsapp_voice description: >- Components without an available estimate. Missing prices do not mean free. finalized_after_call: type: boolean enum: - true '400': description: Invalid country or call direction. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '503': description: >- Prices are temporarily unavailable. No fallback estimate is invented. components: responses: Unauthorized: description: Missing, invalid, expired or revoked API key / access token. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: unauthorized message: Invalid API key. Forbidden: description: >- The credential lacks the required scope or role, or the workspace does not have the required capability. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: scopeDenied: summary: Required scope is missing value: error: code: forbidden message: >- This API key is missing the required scope "assistants:write". apiAccessRequired: summary: API Access is not available value: error: code: api_access_required message: >- API Access is not available for this workspace. Review Settings → Plan. schemas: ErrorEnvelope: type: object description: Error envelope returned by every /api/v1 endpoint on failure. required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - unauthorized - forbidden - api_access_required - not_found - invalid_request - rate_limited - conflict - telephony_configuration_error - telephony_unavailable - destination_forbidden - internal_error description: Stable, machine-readable error code. message: type: string description: Human-readable description of the error. 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`, `billing:write`, `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. ````