Documentation

Guides, references, and resources for SipLive SBC.

📖

Admin Guide

Complete administration guide covering installation, configuration, trunk management, routing, HA clustering, backups, and diagnostics.

View PDF → Download

🔄

Backup & Restore Guide

Step-by-step procedures for local and S3 backups, restore operations, and config rollback.

View PDF → Download

⚙️

HA Setup Guide

Configure active-active high availability clustering with synchronization, failover, and monitoring setup.

Professional License Required

View PDF → Download

🔌

REST API Reference

All endpoints are under /api/v1/

View PDF → Download

Authenticate with a Bearer token on every request:

Authorization: Bearer <token>

Area	Base Path	Description
Trunks	`/api/v1/trunks`	Create, read, update SIP trunks
DIDs	`/api/v1/dids`	Manage DID inventory and routing
Routes	`/api/v1/routes`	Manage routing policies
HMR	`/api/v1/hmr`	Manage header manipulation rule sets
Fraud	`/api/v1/fraud-rules`	Manage destination fraud rules
CDR	`/api/v1/cdr`	Query call records; volume, failed calls, trunk usage summaries
Operations	`/api/v1/ops/`	Stage versions, queue apply/rollback, view history
Backups	`/api/v1/backups`	Trigger and download backups
Diagnostics	`/api/v1/diagnostics`	System health, RTP metrics, diagnostic bundle download
Security	`/api/v1/security/tokens`	Create and revoke scoped API tokens
Audit	`/api/v1/audit`	Immutable log of all UI and API actions
Endpoints	`/api/v1/endpoints/provision`	Full NAP provisioning in one call
Route Simulation	`/api/v1/route-simulate/batch`	Batch routing decision test (up to 200 calls)

📡

SOAP API

PRO

A SOAP interface is available for legacy carrier provisioning systems, providing equivalent coverage to the REST API. Requires a Professional license.

Endpoint

/soap/v1

WSDL

/soap/v1?wsdl