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.

Bring Your Own Phone (BYOP)

Bring your own telephony provider account and start calls through the Vocobase V2 API. This page is a provider-neutral overview; use the provider-specific guides for exact credential fields.

Supported providers

ProviderV2 setup guideStart-call value
TwilioTwilio Setup"twilio"
MCubeMCube Setup"mcube"
ExotelExotel Setup"exotel"
PlivoPlivo Setup"plivo"
VobizVobiz Setup"vobiz"
SIPSIP Setup"sip"
VoiceLinkVoiceLink Setup"voicelink"

Check provider access

Your account must be allowed to use a provider before you can start calls with it.
curl -X GET https://api.vocobase.com/api/v2/config \
  -H "Authorization: Bearer rg_live_abc123def456ghi789jkl012"
The response includes allowed_telephony_providers and a telephony object that shows which providers are configured.
{
  "success": true,
  "data": {
    "allowed_telephony_providers": ["twilio", "plivo", "vobiz"],
    "telephony": {
      "twilio": { "configured": true, "from_number": "+14155551234" },
      "plivo": { "configured": false, "from_number": null },
      "vobiz": { "configured": false, "from_number": null }
    }
  }
}
If the provider you need is missing from allowed_telephony_providers, contact Vocobase support to enable it for your partner account.

Configure credentials

Each provider has its own V2 credential endpoint:
ProviderEndpoint
TwilioPUT /api/v2/config/telephony/twilio
MCubePUT /api/v2/config/telephony/mcube
ExotelPUT /api/v2/config/telephony/exotel
PlivoPUT /api/v2/config/telephony/plivo
VobizPUT /api/v2/config/telephony/vobiz
VoiceLinkPUT /api/v2/config/telephony/voicelink
Use the provider-specific setup page for the required fields and examples.

Start a call

After the provider is enabled and configured, start a call with POST /api/v2/calls/start and pass the provider value.
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": "twilio"
  }'
{
  "success": true,
  "data": {
    "call_id": "c1234567-abcd-1234-abcd-123456789012",
    "session_id": "s1234567-abcd-1234-abcd-123456789012",
    "status": "pending",
    "provider": "twilio",
    "from_number": "+14155551234",
    "to_number": "+919876543210",
    "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Inbound numbers

For inbound calling with Plivo or Vobiz, use the V2 phone-numbers API to sync DIDs and assign agents:
curl -X POST https://api.vocobase.com/api/v2/phone-numbers/sync \
  -H "Authorization: Bearer rg_live_abc123def456ghi789jkl012" \
  -H "Content-Type: application/json" \
  -d '{ "provider": "PLIVO" }'
See Inbound Calls for the full DID assignment flow.

Troubleshooting

SymptomAction
Provider is not allowedAsk Vocobase support to enable the provider for your partner account.
Provider is allowed but not configuredSend the provider’s V2 credential setup request again.
Calls fail immediatelyConfirm the provider credentials, from-number, and destination number format.
Inbound DID does not route to the expected agentRe-check the DID assignment with GET /api/v2/phone-numbers.

Next steps

Quick Start

Create an agent and start your first call.

Inbound Calls

Assign inbound numbers to agents.