RESTful API Webhooks SDKs Available

OctoVoIP API Reference

Build powerful integrations with our RESTful API. Manage calls, users, analytics, and more programmatically.

Terminal
# List recent calls curl -X GET https://api.octovoip.com/v1/calls \ -H "Authorization: Bearer sk_live_abc123..." \ -H "Content-Type: application/json" # Response { "data": [ { "id": "call_9xKp2mNv", "from": "+1-555-0100", "to": "+1-555-0199", "status": "completed", "duration": 124, "recording_url": "https://..." } ], "meta": { "total": 2847, "page": 1 } }

Build with Confidence

Everything you need to create powerful communication integrations, from simple call management to complex AI-driven workflows.

Simple & RESTful

Clean endpoints, JSON responses, and comprehensive error handling. Get started in minutes with predictable, resource-oriented URLs.

Webhooks & Events

Real-time notifications for calls, messages, and status changes. Subscribe to the events you care about and react instantly.

SDKs & Libraries

Official SDKs for Node.js, Python, PHP, and Go. Fully typed, well-documented, and maintained by the OctoVoIP engineering team.

99,9% Uptime

Enterprise-grade reliability with global redundancy. Our infrastructure is built for mission-critical communication applications.

API Endpoints Overview

Explore the full range of OctoVoIP API capabilities. Each endpoint group is fully documented with request/response examples.

Calls

Make, receive, transfer, and manage calls. Access call recordings, transcriptions, and real-time status.

View endpoints

Users & Extensions

Create and manage users, extensions, and permissions. Assign roles and configure user preferences.

View endpoints

IVR & Routing

Configure call flows, auto-attendants, ring groups, and intelligent routing rules programmatically.

View endpoints

Analytics & Reports

Access call logs, recordings, performance metrics, and AI-generated insights for data-driven decisions.

View endpoints

Messaging

Send WhatsApp messages programmatically. Manage conversations, templates, and delivery status.

View endpoints

AI Features

Integrate AI receptionist, real-time transcription, and sentiment analysis into your applications.

View endpoints

Webhooks

Subscribe to real-time events for calls, messages, and system changes. Configure endpoints and manage retries.

View endpoints

Account & Billing

Manage plans, usage, invoices, and payment methods. Monitor usage quotas and billing history.

View endpoints

Start Building in Minutes

Copy-paste examples to get started quickly. All examples use real endpoint patterns with placeholder credentials.

Make a Call POST
// POST /v1/calls

fetch("https://api.octovoip.com/v1/calls", {
  method: "POST",
  headers: {
    "Authorization": "Bearer sk_live_...",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    from: "+15550100",
    to: "+15550199",
    record: true,
    transcribe: true
  })
});

// Response: 201 Created
{
  "id": "call_9xKp2mNv",
  "status": "ringing",
  "created_at": "2026-03-10T..."
}
Set Up a Webhook POST
// POST /v1/webhooks

{
  "url": "https://yourapp.com/webhooks",
  "events": [
    "call.started",
    "call.completed",
    "call.missed",
    "message.received"
  ],
  "secret": "whsec_your_signing..."
}

// Response: 201 Created
{
  "id": "wh_8mPqR3kL",
  "status": "active",
  "events": ["call.started", ...]
}
Get Call Analytics GET
// GET /v1/analytics/calls

curl "https://api.octovoip.com/v1/
analytics/calls?period=7d" \
  -H "Authorization: Bearer sk_..."

// Response: 200 OK
{
  "period": "7d",
  "total_calls": 1284,
  "avg_duration": 186,
  "missed_rate": 0.03,
  "sentiment": {
    "positive": 0.72,
    "neutral": 0.21,
    "negative": 0.07
  }
}
Authentication

Secure API Access with Bearer Tokens

All API requests are authenticated using Bearer tokens. Generate your API key from the OctoVoIP dashboard and include it in every request header.

1
Sign up for an OctoVoIP account and navigate to Settings > API Keys.
2
Generate a new API key. Use test keys (sk_test_) for development and live keys (sk_live_) for production.
3
Include your key in the Authorization header of every request as a Bearer token.
Authentication Header
# Include in every API request curl https://api.octovoip.com/v1/calls \ -H "Authorization: Bearer sk_live_abc123def456" \ -H "Content-Type: application/json" # Test mode (no real calls made) curl https://api.octovoip.com/v1/calls \ -H "Authorization: Bearer sk_test_abc123def456" \ -H "Content-Type: application/json" # Unauthorized request returns: { "error": { "code": "unauthorized", "message": "Invalid or missing API key", "status": 401 } }

Rate Limits & Versioning

Built for scale. Choose the plan that matches your integration needs.

Rate Limits

Plan Requests / min
Starter 1,000
Business 5,000
Enterprise Unlimited

API Information

Current Version
v1 — stable release
Base URL
api.octovoip.com/v1
Response Format
All responses return JSON with standard HTTP status codes

Ready to Start Building?

Get your API key today and start integrating OctoVoIP into your applications. Our developer support team is here to help via live chat and email.