Documentation
Everything you need to configure your SIP trunk and start building voice applications.
Quick Start Guide
Get up and running in 5 minutes. Create an account, add your trunk, and make your first call.
- 1. Sign up and log in to the dashboard
- 2. Navigate to SIP Trunks and add your carrier
- 3. Add a SIP gateway with your provider's IP and port
- 4. Create an Application with your webhook URL
- 5. Register a phone number and assign it to your trunk + application
- 6. Make a test call - your webhook will receive the call event
SIP Trunk Configuration
Detailed guide for configuring different SIP trunk providers.
- Each SIP trunk needs a Carrier (provider config) and one or more Gateways (IP endpoints).
- For trunk registration: Enable "Requires Registration" and provide username, password, and SIP realm.
- For IP-based auth: Just add gateway IPs. Most providers support this.
- Supported protocols: UDP, TCP, TLS, TLS/SRTP.
- Tech prefix: Add if your provider requires a prefix for routing.
Webhook Reference
How call hooks work and what your server needs to return.
- When an inbound call arrives, we POST to your Call Hook URL with call details (from, to, call_sid).
- Your server must respond with an array of Jambonz verbs (JSON).
- Common verbs: say, play, gather, dial, listen, record, hangup, pause, conference.
- The Call Status URL receives lifecycle events: trying, ringing, in-progress, completed, failed.
- See jambonz.org/docs for the full verb reference.
Recording Setup
How to enable and access call recordings.
- Enable "Record all calls" in your Application settings to automatically record every call.
- Recordings are stored in S3-compatible storage and accessible via the dashboard.
- You can also use the Record verb in your webhook response for selective recording.
- Recordings include: duration, file size, MIME type, and a download URL.