Skip to main content
POST
/
telephony
/
connections
Create a telephony connection
curl --request POST \
  --url https://api.vocobase.com/api/v2/telephony/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Plivo India - Sales",
  "account_sid": "<string>",
  "auth_id": "<string>",
  "auth_token": "<string>",
  "api_key": "<string>",
  "subdomain": "<string>",
  "caller_id": "<string>",
  "from_number": "<string>",
  "sip_host": "<string>",
  "outbound_username": "<string>",
  "outbound_password": "<string>",
  "source_ips": [
    "<string>"
  ],
  "did_number": "<string>",
  "username": "<string>",
  "password": "<string>",
  "base_url": "<string>",
  "tata_email": "ops@example.com",
  "tata_password": "your-smartflo-password",
  "agent_number": "<string>",
  "jwt_token": "<string>",
  "exe_number": "9876543232"
}
'
{
  "success": true,
  "data": {
    "connection": {
      "id": "9b7f1c44-c87f-4f0c-9124-3c802a9c1a20",
      "connection_id": "9b7f1c44-c87f-4f0c-9124-3c802a9c1a20",
      "provider": "plivo",
      "provider_key": "PLIVO",
      "name": "Plivo India - Sales",
      "status": "ACTIVE",
      "is_default": true,
      "phone_numbers": []
    }
  }
}

Authorizations

Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Body

application/json
provider
enum<string>
required

Telephony provider to connect.

Available options:
twilio,
exotel,
plivo,
vobiz,
tata_smartflo,
sip,
voicelink,
mcube
name
string
required

Human-readable connection name.

Required string length: 1 - 100
Example:

"Plivo India - Sales"

account_sid
string

Twilio/Exotel account SID, or Plivo/Vobiz auth ID.

auth_id
string

Alias for account_sid for Plivo/Vobiz.

auth_token
string

Provider auth token.

api_key
string

Exotel API key.

subdomain
string

Exotel account subdomain.

caller_id
string

Exotel caller ID.

from_number
string

Default outbound DID in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
sip_host
string

SIP carrier host for BYOP SIP connections.

outbound_username
string

Outbound SIP username.

outbound_password
string

Outbound SIP password.

source_ips
string[]

SIP carrier source IPs or CIDR ranges for inbound calls.

did_number
string

DID for SIP or VoiceLink connections.

Pattern: ^\+[1-9]\d{6,14}$
sip_transport
enum<string>

SIP transport protocol.

Available options:
UDP,
TCP,
TLS
username
string

VoiceLink username.

password
string

VoiceLink password.

base_url
string<uri>

Optional VoiceLink or Tata Smartflo API base URL.

tata_email
string<email>

Tata Smartflo panel email. Required when provider is tata_smartflo.

Example:

"ops@example.com"

tata_password
string

Tata Smartflo panel password. Stored encrypted; never returned. Required when provider is tata_smartflo.

Example:

"your-smartflo-password"

agent_number
string

Optional Tata Smartflo outbound agent leg number. Use only after Vocobase confirms the required Smartflo value for your account.

jwt_token
string

MCube JWT authentication token (required for MCube).

exe_number
string

MCube exenumber — the line outbound calls are placed from. National format allowed (no + required); stored as the connection's default phone number. Required for MCube.

Pattern: ^\+?\d{4,15}$
Example:

"9876543232"

Response

Connection created.

success
boolean
data
object