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.

​
Vobiz Setup

This guide walks you through connecting your Vobiz account to Vocobase for outbound calling.
Configure Vobiz with the Partner API (PUT /api/v2/config/telephony/vobiz). Once Vobiz is configured, start calls programmatically using POST /calls/start with "provider": "vobiz".

​
Prerequisites

  • A Vobiz account with a verified Auth ID and Auth Token
  • At least one Vobiz phone number provisioned for outbound voice
  • An approved Vocobase partner account with "vobiz" present in allowed_telephony_providers (check GET /config)
If "vobiz" is not yet listed in your partner config’s allowed_telephony_providers, contact your Vocobase account manager to enable it.

​
Step 1: Get your Vobiz credentials

1

Log in to the Vobiz dashboard

Go to vobiz.ai and sign in to your account.
2

Copy your Auth ID and Auth Token

From your account settings, copy your Auth ID and Auth Token.
  • Auth ID — identifier in the form MA_XXXXXXXX
  • Auth Token — alphanumeric string
Your Auth Token grants full access to your Vobiz account. Treat it like a password.
3

Identify the phone number you will call from

From your Vobiz account, copy the number you plan to use as the caller ID.The number must be in E.164 format (e.g., +918011223344) and must be enabled for outbound voice.

​
Step 2: Configure Vobiz in Vocobase

Send the credentials through the Partner API. 
curl -X PUT https://api.vocobase.com/api/v2/config/telephony/vobiz \
  -H "Authorization: Bearer rg_live_abc123def456ghi789jkl012" \
  -H "Content-Type: application/json" \
  -d '{
    "auth_id": "MA_XXXXXXXX",
    "auth_token": "your_vobiz_auth_token",
    "from_number": "+918011223344"
  }'
A successful response confirms credentials were stored: 
{
  "success": true,
  "data": {
    "auth_id": "MA_X****XXXX",
    "from_number": "+918011223344",
    "message": "Vobiz credentials updated successfully."
  }
}
Your Auth Token is encrypted at rest and never returned in API responses. The Auth ID is masked.

​
Step 3: Confirm the partner sees Vobiz as configured

Fetch your partner configuration — the response should now include Vobiz in allowed_telephony_providers: 
curl -X GET https://api.vocobase.com/api/v2/config \
  -H "Authorization: Bearer rg_live_abc123def456ghi789jkl012"

{
  "success": true,
  "data": {
    "name": "acme-corp",
    "allowed_telephony_providers": ["twilio", "vobiz"],
    "telephony": {
      "twilio": { "configured": true, "account_sid": "conf****ured", "from_number": "+14155551111" },
      "mcube": { "configured": false, "exe_number": null },
      "exotel": { "configured": false, "account_sid": null, "subdomain": null, "caller_id": null, "applet_id": null },
      "plivo": { "configured": false, "auth_id": null, "from_number": null },
      "vobiz": { "configured": true, "auth_id": "conf****ured", "from_number": "+918011223344" }
    },
    "...": "..."
  }
}
telephony.vobiz.configured: true confirms the credentials landed and a default from-number is set. Presence in allowed_telephony_providers is what gates your ability to start a Vobiz call — if Vobiz isn’t in that list, contact your Vocobase account manager to enable it.

​
Step 4: Make a test call

Start an outbound call with "provider": "vobiz": 
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": "vobiz"
  }'

{
  "success": true,
  "data": {
    "call_id": "c1234567-abcd-1234-abcd-123456789012",
    "session_id": "s1234567-abcd-1234-abcd-123456789012",
    "status": "pending",
    "provider": "vobiz",
    "from_number": "+918011223344",
    "to_number": "+919876543210",
    "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}
Vocobase manages the carrier connection and media path for Vobiz. Partners only need to configure credentials and pass "provider": "vobiz" when starting calls.

​
Optional: voicemail detection

For Vobiz outbound calls, supported accounts can enable carrier-side voicemail detection per agent. Set voicemail_detection_enabled to control detection for that agent. When Vobiz reports voicemail, Vocobase marks the call as voicemail and ends the call. The same agent field, voicemail_message, is accepted for API parity and for providers that can play a post-detection message. Vobiz currently uses the hangup behavior above.
Carrier-side voicemail detection must be enabled for your Vobiz connection by Vocobase before these agent settings affect live calls.
curl -X PUT https://api.vocobase.com/api/v2/agent/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer rg_live_abc123def456ghi789jkl012" \
  -H "Content-Type: application/json" \
  -d '{
    "voicemail_detection_enabled": true,
    "voicemail_message": "Hi, this is Priya from Acme Corp. I will call you back soon."
  }'

​
Troubleshooting

​
”Vobiz not configured” or 403 on /calls/start

  • Confirm "vobiz" is in allowed_telephony_providers from GET /config. If it is not, contact your Vocobase account manager.

​
401 from Vobiz during verification

  • Auth ID or Auth Token is wrong. Re-copy them from your Vobiz account settings.
  • If you recently rotated the Auth Token in Vobiz, send PUT /config/telephony/vobiz again with the new token.

​
Calls ring but drop immediately

  • Confirm the destination number is reachable from your Vobiz account. Some Vobiz accounts have geographic restrictions that require explicit enablement.
  • Check the Vobiz call logs for the exact reason the call was dropped (e.g., “Invalid from number”, “No route to destination”).

​
Caller ID shows the wrong number or “Unknown”

  • The from_number saved on your Vocobase Vobiz connection must match a number that Vobiz has provisioned for your account, in E.164 format. Update it via PUT /config/telephony/vobiz if it does not.

​
Updating credentials

Rotate the Auth Token in Vobiz, then update Vocobase by re-sending PUT /api/v2/config/telephony/vobiz with the new token.

​
Next steps

Plivo Setup

Configure Plivo as an additional telephony provider.

Quick Start

Create an agent and make your first call.