Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vocobase.com/llms.txt

Use this file to discover all available pages before exploring further.

​
SIP (BYOP) Setup

This guide walks you through connecting your own SIP carrier to Vocobase for inbound and outbound calling.
SIP is a Bring-Your-Own-Provider (BYOP) transport. You bring a carrier that supports standard SIP, and Vocobase manages the voice-agent connection for inbound and outbound calls.

​
Prerequisites

  • A Vocobase partner account with "SIP" present in allowed_telephony_providers (check GET /api/v2/config). If it is not listed, contact your Vocobase account manager to enable it.
  • An account with any SIP carrier, with the following details ready:
    • SIP host — the carrier’s SIP server hostname (e.g., sip.your-carrier.com)
    • Outbound auth username + password — the SIP credentials your carrier issues for INVITE authentication
    • Source IPs — the carrier’s egress IPs from which inbound SIP INVITEs originate (used to allowlist inbound traffic)
    • At least one DID (phone number in E.164 format) provisioned on the carrier for inbound and/or outbound voice
  • Access to the Vocobase dashboard at app.vocobase.com

​
Step 1: Gather your carrier credentials

1

Log in to your SIP carrier's portal

Sign in to your carrier’s dashboard (Vobiz, Tata Tele, Knowlarity, or whichever ITSP you use).
2

Locate your SIP trunk settings

Find the SIP trunk / SIP gateway section. You are looking for:
  • SIP host — typically a hostname like sip.carrier.com or pbx.carrier.com
  • Auth username and auth password — the credentials Vocobase will present when placing outbound INVITEs through your carrier
  • Source IPs — the IPs your carrier uses to send inbound INVITEs to subscribers. Most carriers publish these in their docs.
Your SIP auth password grants outbound calling on your trunk. Treat it like any production secret.
3

Confirm your DID(s)

From the carrier portal, note each phone number you plan to use, in E.164 format (e.g., +918011223344). These are the numbers Vocobase will use as caller IDs on outbound calls and bind to inbound routing on inbound calls.

​
Step 2: Add the SIP connection in Vocobase

1

Open the dashboard

Go to app.vocobase.com and sign in.
2

Add a SIP connection

Navigate to Settings → Telephony Settings and click Add Connection. Pick SIP from the provider list.Fill in:
  • Connection name — a label for this trunk (e.g., Vobiz SIP — Production, Tata Tele India)
  • SIP host — from Step 1
  • Auth username + password — from Step 1
  • Source IPs — comma-separated, from Step 1
  • DIDs — the E.164 phone numbers you provisioned
3

Save and copy the SIP URI

On Save, Vocobase displays the SIP URI for this connection.Paste that URI into your carrier’s DID-origination or outbound routing setting so that calls to your DIDs are forwarded to Vocobase. The exact field name varies by carrier (often called origination URI, SIP termination URL, or destination SIP URI).

​
Step 3: Make an outbound test call

Start an outbound call with "provider": "sip": 
curl -X POST https://api.vocobase.com/api/v2/calls/start \
  -H "Authorization: Bearer rg_live_abc123def456ghi789jkl012" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "to_number": "+919876543210",
    "provider": "sip"
  }'
A successful response looks like: 
{
  "success": true,
  "data": {
    "call_id": "c1234567-abcd-1234-abcd-123456789012",
    "session_id": "s1234567-abcd-1234-abcd-123456789012",
    "status": "pending",
    "provider": "sip",
    "from_number": "+918011223344",
    "to_number": "+919876543210",
    "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

​
How it works

  • Outbound — Vocobase starts the call through your SIP carrier and connects the call to your selected agent.
  • Inbound — When a caller dials one of your DIDs, your carrier forwards the call to the SIP URI you configured and Vocobase routes it to the assigned agent.
  • Transfer — Transfers use the same configured carrier connection and include transfer metadata in the session.completed webhook.

​
Next steps

Vobiz Setup

Configure Vobiz as another telephony provider.

Quick Start

Create an agent and make your first call.