API docs by Redocly

Fonella API (1.0.0)

Download OpenAPI specification:Download

Official API documentation for the Fonella backend services.

Public

Public endpoints without authentication.

List Public Plans

Returns publicly available pricing plans.

Responses

Response samples

Content type
application/json
{
  • "plans": [
    ]
}

Health Check

Returns API runtime health information.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "service": "fonella-api",
  • "stage": "prod",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Request Test Call

Starts a test callback request through VAPI.

Request Body schema: application/json
phoneNumber
required
string
company
string
preferredWindow
string
notes
string
recaptchaToken
string

Responses

Request samples

Content type
application/json
{
  • "phoneNumber": "+491701234567",
  • "company": "Fonella GmbH",
  • "preferredWindow": "Today 14:00-16:00",
  • "notes": "Please call via office line.",
  • "recaptchaToken": "03AFcWeA..."
}

Response samples

Content type
application/json
{ }

Submit Contact Form

Submits the public contact form.

Request Body schema: application/json
name
required
string
email
required
string <email>
company
string
message
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Max Mustermann",
  • "email": "max@example.com",
  • "company": "Fonella GmbH",
  • "message": "I would like to book a demo."
}

Response samples

Content type
application/json
{ }

VAPI Webhook

Receives webhook events from VAPI.

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Authentication

Authentication and session endpoints.

Validate Access Token

Validates the provided bearer token and returns user context.

Responses

Response samples

Content type
application/json
{ }

Logout Session

Logs out the authenticated user session.

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Subscription

Subscription management endpoints.

Create Subscription

Creates a new subscription for the authenticated user.

Request Body schema: application/json
planId
required
string
Enum: "starter" "business" "premium"

Responses

Request samples

Content type
application/json
{
  • "planId": "business"
}

Response samples

Content type
application/json
{ }

Get Subscription

Returns the current subscription of the authenticated user.

Responses

Response samples

Content type
application/json
{ }

Reactivate Subscription

Reactivates a previously scheduled cancellation.

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Schedule Subscription Cancellation

Schedules subscription cancellation at the period end.

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Schedule Plan Change

Schedules a subscription plan change.

Request Body schema: application/json
targetPlanId
required
string
Enum: "starter" "business" "premium"

Responses

Request samples

Content type
application/json
{
  • "targetPlanId": "premium"
}

Response samples

Content type
application/json
{ }

Billing

Invoice and billing endpoints.

List Invoices

Returns invoices for the authenticated user.

Responses

Response samples

Content type
application/json
{ }

Settings

User settings endpoints.

Get User Settings

Returns settings for the authenticated user.

Responses

Response samples

Content type
application/json
{ }

Update User Settings

Updates settings for the authenticated user.

Request Body schema: application/json
name
string
email
string <email>
timezone
string

Responses

Request samples

Content type
application/json
{
  • "name": "Max Mustermann",
  • "email": "max@fonella.ai",
  • "timezone": "Europe/Berlin"
}

Response samples

Content type
application/json
{ }

Files

File management endpoints.

Delete File

Deletes an uploaded user file by id.

path Parameters
fileId
required
string

Unique file identifier.

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted successfully."
}

List Files

Returns uploaded files for the authenticated user.

Responses

Response samples

Content type
application/json
{ }

Upload File

Uploads a file for the authenticated user.

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Analytics

Usage and call analytics endpoints.

List Call Logs

Returns recent call logs for the authenticated user.

Responses

Response samples

Content type
application/json
{ }

Get Usage Metrics

Returns usage metrics for the authenticated user.

Responses

Response samples

Content type
application/json
{ }

Assistant

Assistant setup endpoints.

Setup Assistant

Creates or updates assistant setup for the authenticated user.

Request Body schema: application/json
greeting
string
language
string

Responses

Request samples

Content type
application/json
{
  • "greeting": "Hello, this is Fonella.",
  • "language": "de"
}

Response samples

Content type
application/json
{ }

Account

Account lifecycle endpoints.

Request Account Deletion

Submits an account deletion request.

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Request Data Export

Starts a personal data export request.

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Integrations

Third-party integration endpoints.

Delete SIP Integration

Deletes SIP integration settings.

Responses

Response samples

Content type
application/json
{
  • "message": "Deleted successfully."
}

Get SIP Integration

Returns SIP integration settings.

Responses

Response samples

Content type
application/json
{ }

Save SIP Integration

Creates or updates SIP integration settings.

Request Body schema: application/json
host
required
string
username
required
string
password
string

Responses

Request samples

Content type
application/json
{
  • "host": "sip.example.net",
  • "username": "1001",
  • "password": "********"
}

Response samples

Content type
application/json
{ }