Skip to main content

VoiceLink Setup

This guide walks you through connecting your VoiceLink account to Vocobase for inbound and outbound calling.
Configure VoiceLink with the Partner API (PUT /api/v2/config/telephony/voicelink) for the default connection. To create multiple named VoiceLink connections, use POST /api/v2/telephony/connections. Once VoiceLink is configured, start calls programmatically using POST /calls/start with "provider": "voicelink".

Prerequisites

  • A VoiceLink account with a panel username and password
  • At least one VoiceLink DID (phone number) provisioned for voice
  • An approved Vocobase partner account with "voicelink" present in allowed_telephony_providers (check GET /config)
If "voicelink" is not yet listed in your partner config’s allowed_telephony_providers, contact your Vocobase account manager to enable it.
1

Find your VoiceLink panel sign-in

Use the same username and password you use to sign in to the VoiceLink panel. Vocobase logs in with these to obtain a short-lived access token when it calls the VoiceLink API on your behalf — your password is stored encrypted and never sent back to you.
These credentials grant full access to your VoiceLink account. Treat them like any other production secret.
2

Identify the DID you will call from

Copy the VoiceLink 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.
Send the credentials through the Partner API. username, password, and from_number are required; base_url is optional and defaults to the VoiceLink API host.
This endpoint updates your default VoiceLink connection. To create multiple named VoiceLink connections, use POST /api/v2/telephony/connections and store the returned connection_id.
A successful response confirms credentials were stored:
Your password is encrypted at rest and never returned in API responses.

Optional: custom base URL

If VoiceLink gave you a dedicated API host, pass it as base_url. Omit the field to use the default host.
Fetch your partner configuration — the response should now include VoiceLink in allowed_telephony_providers:
telephony.voicelink.configured: true confirms the credentials and from-number landed. Presence in allowed_telephony_providers is what gates your ability to start a VoiceLink call — if VoiceLink 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": "voicelink". If your partner account has multiple active VoiceLink connections, include connection_id.
VoiceLink uses a Generic WebSocket media model. Vocobase manages the media path; partners only need to configure credentials and pass "provider": "voicelink" when starting calls. Passing only "provider": "voicelink" remains valid while there is exactly one active VoiceLink connection.
Inbound calling is configured per DID through the guided dashboard workflow or POST /api/v2/voicelink/inbound-ready. Call transfer support depends on the active VoiceLink media integration and remains outside this setup guide.

Managing DIDs

The from_number you send is stored as the default outbound DID. To manage multiple VoiceLink DIDs, create named V2 telephony connections and select the desired one with connection_id when starting outbound calls. For inbound setup, client and DID mapping, sync, and readiness checks, use the VoiceLink Management guide. It documents the safe inbound/outbound composers under /api/v2/voicelink/*, including connection_id support for multiple active VoiceLink connections.

Troubleshooting

  • Confirm "voicelink" is in allowed_telephony_providers from GET /config. If it is not, contact your Vocobase account manager.
  • Confirm username, password, and a from_number were saved (telephony.voicelink.configured: true).

CONNECTION_AMBIGUOUS error

  • Your account has multiple active VoiceLink connections. Call GET /api/v2/telephony/connections?provider=voicelink and pass the desired connection_id in POST /api/v2/calls/start.
  • Re-check the credentials against the VoiceLink panel sign-in. Re-send PUT /config/telephony/voicelink with the correct values.

Calls ring but drop immediately

  • Confirm the destination number is reachable from your VoiceLink account.
  • Check the VoiceLink panel call logs for the exact drop reason.

Caller ID shows the wrong number

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

Updating credentials

Changed your VoiceLink password? Re-send PUT /api/v2/config/telephony/voicelink with the new password. This endpoint always requires username, password, and from_number together, so include all three (plus base_url if you use a custom host) whenever you update.

Next steps

Telephony Connections

Create and manage multiple named connections.

VoiceLink Management

Manage clients, DIDs, mapping, and readiness.

Bring Your Own Phone

Overview of all supported BYOP providers.

Quick Start

Create an agent and make your first call.