Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

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

This guide walks you through connecting a web browser (WebRTC) to Vobiz so you can make and receive phone calls directly from a web application.
Reference repository: vobiz-ai/Vobiz-RTC-demo

​
Step 1: Create a Voice Application

Your browser app needs a backend to tell Vobiz how to handle calls.
1

Open the console

Log in to the Vobiz Console and navigate to Voice → Applications.
2

Create the application

Click Create New Application and enter a name (for example, WebRTC Demo).
3

Set the Answer URL

Set the Answer URL to your backend server URL. This is the most critical part - Vobiz calls this URL to receive XML instructions for handling the call.Example logic for the Answer URL:
// The server receives a request with a 'To' parameter
// and returns XML to bridge the call.
const vobizXml = `
  <Response>
    <Dial callerId="${YOUR_VOBIZ_NUMBER}">
      <Number>${destinationNumber}</Number>
    </Dial>
  </Response>
`;
4

Set the Event URL (optional)

Add an Event URL to receive call status updates (ringing, answered, hung up).
5

Save

Click Save.
Your Voice Application is created. Vobiz now knows exactly what to do when a call comes in.

​
Step 2: Attach a phone number

Link a phone number to your application so it can receive calls.
  1. Stay on the application page (or edit your application).
  2. Look for the Phone Numbers section or dropdown.
  3. Select a purchased phone number to link to this application.
  4. Click Save.
Calls to this number are now handled by your Answer URL.
Phone number linked. Your caller ID is set up and ready to go.

​
Step 3: Configure your endpoint (user agent)

An endpoint acts as the user (the “phone”) in the browser.
1

Open endpoints

Go to Voice → Endpoints.
2

Create the endpoint

Click Create Endpoint and set:
  • Username - a unique username (for example, agent001).
  • Password - a strict password.
  • Assign Application - select the WebRTC Demo application created in Step 1.
This links your browser user to the specific backend logic.
3

Save credentials

Click Create and note down the username and password. You’ll use these to log in from the browser SDK.
Endpoint created. Your browser now has the credentials it needs to “log in” and act as a real phone.

​
Step 4: Run the client

Use the hosted demo or run the code locally.

Option A: Live demo (quickest)

  1. Visit https://rtc-demo.vobiz.ai/.
  2. Enter the Endpoint Username and Password created in Step 3.
  3. Click Connect.

Option B: Run locally

Clone the reference repo and configure with your credentials. See the steps below.

​
Running locally

# Clone the repo
git clone https://github.com/vobiz-ai/Vobiz-RTC-demo.git
cd Vobiz-RTC-demo

# Install dependencies
npm install

# Start the backend (handles Answer URL requests)
npm start

# Start the frontend
npm run client
  • Make sure the backend server is accessible from the internet, and update your Vobiz application’s Answer URL to point to it.
  • Open http://localhost:8080, enter your endpoint credentials, and connect.

​
Key concepts

​
Answer URL logic

The backend server (provided in the demo repo) listens for incoming call requests. Vobiz sends an HTTP request with parameters like From, To, and CallSid. Your server must return valid VobizXML. Example: bridging a call. 
<Response>
  <Dial callerId="+15551112222">
    <Number>+15559998888</Number>
  </Dial>
</Response>
  • callerId - must be a number you own or have verified on Vobiz.
  • Number - the destination number to connect to.

​
Next steps