Skip to main content
Vonage (now part of Ericsson) is a cloud communications platform providing programmable voice, messaging, and video APIs. Rapida integrates with Vonage to enable AI-powered phone conversations using Vonage’s WebSocket media streaming.
Vonage uses WebSocket audio streams for real-time media. When a call connects, Vonage opens a WebSocket to Rapida carrying linear PCM audio. Rapida handles all codec conversion and resampling transparently.

How It Works


Prerequisites

Vonage Account

An active Vonage account with at least one phone number and a Vonage Application

Rapida Account

An active Rapida account with a configured voice assistant
You will need your Vonage Application ID and Private Key, which you can find in the Vonage API Dashboard.

Step 1: Set Up Provider Credentials

Store your Vonage API credentials in Rapida so the platform can authenticate with Vonage for outbound calls and webhook handling.
1

Navigate to External Integrations

Go to Integration > Tools in the Rapida dashboard. You will see a grid of available external integrations.External Integrations Page
2

Select Vonage

Find the Vonage card and click “Setup Credential”.
3

Enter Your Vonage Credentials

Vonage CredentialsA modal will appear. Fill in the following fields:
FieldDescriptionWhere to Find
Key NameA friendly name for this credential (e.g., “Production Vonage”)Your choice
Application IDYour Vonage Application IDVonage Dashboard → Applications → Your App
Private KeyYour Vonage Application private key (full PEM content)Downloaded when creating the Vonage Application
Click “Configure” to save.
The private key is the full PEM file content, not just a token. It typically begins with -----BEGIN RSA PRIVATE KEY-----. Paste the entire contents.
4

Verify Connection

After saving, the Vonage card should display “Connected”. Click on it to see credential details, last updated time, and management options.

Step 2: Configure Phone Deployment

With credentials saved, configure your assistant’s phone deployment to use Vonage.
1

Open Your Assistant

Navigate to Assistants and select the assistant you want to deploy via phone.
2

Go to Phone Deployment

Click “Deploy”“Phone” to open the phone deployment configuration page.
3

Select Vonage as Telephony Provider

In the Telephony section:
  1. Select Vonage from the telephony provider dropdown
  2. Choose the Vonage credential you created in Step 1 from the Credential dropdown
  3. Enter your Phone number — the Vonage virtual number for inbound calls and outbound caller ID (e.g., +15551234567)
4

Configure Experience Settings

Set up the conversation experience:
SettingDescriptionDefault
GreetingThe first message the AI speaks when answering(optional)
Error MessageMessage spoken when an error occurs(optional)
Idle TimeoutSeconds before prompting an idle caller30
Idle MessageMessage spoken when caller is idle"Are you there?"
Idle Timeout RetriesHow many times to retry before ending call2
Max Call DurationMaximum call length in seconds300
5

Configure Audio Providers

Select your Speech-to-Text (STT) and Text-to-Speech (TTS) providers. These determine how audio is transcribed and synthesized during the call.
6

Save Deployment

Click “Deploy” to save. Your assistant is now ready to handle phone calls via Vonage.

Step 3: Configure Your Vonage Application

Point your Vonage Application’s webhook URLs to Rapida so incoming calls are routed to your AI assistant.
1

Open Vonage Dashboard

Go to Vonage Dashboard → Applications and select your application.
2

Set Voice Webhooks

Under Capabilities → Voice, configure:
FieldValue
Answer URLhttps://websocket-01.in.rapida.ai/v1/talk/vonage/call/{your-assistant-id}?x-api-key={your-api-key}
Event URLhttps://websocket-01.in.rapida.ai/v1/talk/vonage/ctx/{contextId}/event?x-api-key={your-api-key}
HTTP MethodPOST
Replace {your-assistant-id} with your Rapida assistant ID.
3

Link Phone Number

Under Numbers, link your Vonage virtual number to this application so inbound calls are routed through it.
4

Save

Click Save in the Vonage dashboard. Your phone number is now connected to Rapida.

Making Outbound Calls

Once your phone deployment is configured, you can initiate outbound calls using the Rapida API or SDKs.
from rapida import Rapida

client = Rapida(api_key="rpd-xxx-your-key")

call = client.calls.create(
    assistant_id=123456789,
    to_number="+15551234567",
    from_number="+15559876543",  # optional, uses deployment default
    metadata={"campaign": "follow-up"},
)

print(f"Call queued: conversation_id={call.conversation.id}")

Features

FeatureDescription
Inbound CallsCustomers call your Vonage number and speak with your AI assistant
Outbound CallsInitiate calls programmatically via SDK or API
Real-time StreamingBidirectional audio via Vonage WebSocket streams
Call RecordingAutomatic conversation capture for review and compliance
Status CallbacksReceive call lifecycle events via Vonage event webhooks
Number InsightGet detailed information about phone numbers
Global NumbersUse Vonage virtual numbers from 80+ countries

Troubleshooting

  • Verify the Answer URL in your Vonage Application settings
  • Ensure the URL uses https:// and the correct assistant ID
  • Confirm the phone number is linked to the correct Vonage Application
  • Verify your Vonage credential (Application ID + Private Key) is correct in Rapida
  • Ensure the private key is the complete PEM content
  • Check that your STT and TTS providers are configured in the phone deployment
  • Verify the Vonage credential is connected in Integration > Tools
  • Ensure the from_number is a valid Vonage number linked to your application
  • Check that the phone deployment is configured and saved
  • Ensure the Event URL is configured in Vonage Application settings
  • Verify the URL format includes the correct path
  • Check the Vonage API Dashboard for webhook delivery logs

For more information on Vonage’s platform, visit the Vonage API Developer Documentation.