integrations/voice/telephony/vobiz/) connects to Vobiz using its REST API and dynamic XML answer callbacks.
Vobiz Calling Pipeline
Required Credentials
To connect Vobiz to BrokerOS, obtain the following credentials from your Vobiz account portal:CRM Telephony PSTN Bridging Setup
To use Vobiz as the organization-wide carrier for human telecalling:- Navigate to Dashboard -> Admin -> Settings -> CRM Telephony & WebRTC (
/dashboard/admin/settings). - Select the Vobiz Telephony carrier card.
- Enter the following parameters:
- Auth ID (X-Auth-ID): Your Vobiz Auth ID string.
- Auth Token (X-Auth-Token): Secret Vobiz auth token.
- Registered Caller ID: Your verified Indian mobile or landline number (e.g.,
+919876543210).
- Click Save & Activate Carrier.
- When calls are placed, Vobiz triggers
/api/crm/telephony/webhooks/vobiz-answerto bridge the agent and lead phones, and delivers audio recordings to/api/crm/telephony/webhooks/vobiz-recording.
Marketing AI Voice Configuration Steps
1
Retrieve Credentials from Vobiz Portal
Log in to your account at
portal.vobiz.in. Under API & Credentials, copy your X-Auth-ID and X-Auth-Token.2
Ensure API_PUBLIC_URL is Configured
Vobiz requires an accessible public HTTP or HTTPS webhook URL for its If testing locally, start an ngrok tunnel (e.g.,
answer_url callback. In your root .env or production deployment environment, ensure API_PUBLIC_URL points to your public domain or tunnel:API_PUBLIC_URL="https://brokeros.ngrok-free.app"). The dispatcher explicitly validates that API_PUBLIC_URL is a valid public URL and not localhost.3
Add Carrier in BrokerOS Settings
In the BrokerOS dashboard:
- Navigate to Dashboard -> Marketing -> Voice -> Settings.
- Select the Gateways & Voice Platforms tab (
/dashboard/marketing/voice/settings?tab=providers). - Under the Telephony Gateways sub-tab, click Add Carrier and select VOBIZ.
- Enter an Engine Label / Name (e.g.
Vobiz India Primary Trunk). - Paste your X-Auth-ID into the API Key field.
- Paste your X-Auth-Token into the API Token field.
- Enter your verified Indian caller ID in the From Numbers field.
- Click Save & Verify Carrier. Credentials are encrypted with AES-256-GCM and stored in
VoiceTelephonyIntegration.
4
Verify Carrier Connection
Click Verify Carrier. BrokerOS tests credentials against
https://api.vobiz.ai/api/v1/account and measures the connection latency. Upon success, a green badge displays the response time.5
Run a Dual-Mode Test Call
Open the Campaign Wizard or Agent Composer, click Test Call, select Carrier Bridge PSTN, and verify that your personal handset rings with your configured Indian CLI.
Dynamic XML Answer Callback
When a customer answers an outbound call originated through Vobiz, Vobiz makes an immediate HTTP GET or POST request to the BrokerOS answer webhook:Troubleshooting & Best Practices
- Error: Vobiz API requires a public HTTP/HTTPS webhook URL: Occurs when
API_PUBLIC_URLis either empty or points tolocalhost/127.0.0.1. Update your environment configuration with a publicly resolvable hostname. - Error: Missing Vobiz X-Auth-ID or X-Auth-Token: Verify that both fields are populated in Telephony Carriers Settings.
- CLI Presentation Issues: Telecom operators in India require caller IDs to be pre-registered with your telecom account. Ensure the phone number in
From Numbersmatches an active CLI in your Vobiz dashboard.