SIPSIM API Documentation

Welcome to the SIPSIM API! Build powerful voice integrations that enable your applications to manage calls, access call recordings, leverage AI-powered transcription and summaries, and much more.

What is SIPSIM?

SIPSIM is a business phone system that provides phone numbers with advanced calling features. The SIPSIM API allows you to programmatically access and control your phone system, enabling seamless integration with your CRM, helpdesk, or custom applications.

What Can You Build?

With the SIPSIM API, you can:

• Access Call History — Retrieve detailed call logs with filtering by date, employee, tags, and call type
• Click-to-Call — Initiate outbound calls directly from your application
• AI Transcription — Get full transcriptions of your calls with speaker identification
• AI Summaries — Generate intelligent summaries of calls with custom instructions
• Manage Tags — Organize and categorize calls with custom tags
• Manage Groups — Create and assign groups to organize your phone lines

Quick Start

1. Create an API Integration

First, create an API integration in your SIPSIM dashboard to get your credentials. See Create Integration for detailed instructions.

2. Get an Access Token

Exchange your credentials for an access token:

curl -X POST https://app.sipsim.com/oauth/token \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

3. Make Your First API Call

Use the access token to call the API:

curl https://app.sipsim.com/api/v2/account \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response:

{
  "status": 200,
  "request_id": "abc123",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "id": 12345,
    "company_name": "Acme Corp",
    "email": "admin@acme.com"
  }
}

API Overview

Base URL

All API requests use the following base URL:

https://app.sipsim.com/api/v2

Authentication

The API uses OAuth 2.0 with the Authorization Code flow. All requests must include a valid access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Response Format

All responses follow a consistent envelope format:

{
  "status": 200,
  "request_id": "unique-request-id",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": { ... },
  "pagination": {
    "count": 100,
    "limit": 1000,
    "page": "next_page_token",
    "has_more": true
  }
}

Rate Limiting

The API implements rate limiting to ensure fair usage. If you exceed the limit, you'll receive a 429 Too Many Requests response.

Available Endpoints

Resource	Description
Account	Get account information
Calls	List calls, get call details, initiate calls
Phones	List phone lines and their configuration
Tags	Create and manage call tags
Groups	Create and manage phone groups
Settings	Configure AI summary settings

Next Steps

Getting Started

Set up your API integration and authenticate your first request.

Get Started

API Reference

Explore all available endpoints with request/response examples.

View Reference

Need Help?

• Support: Contact us at support@sipsim.com