This guide walks you through connecting your Vonage Business Communications (VBC) account to Voxjar. Once connected, Voxjar pulls your call logs and recordings on a schedule and evaluates every call automatically. Setup happens in three places: the Vonage Admin Portal, the Vonage Developer Portal, and Voxjar. Plan for about 30 minutes once you have developer portal access.
Prerequisites
A Vonage Business Communications account. This guide does not apply to the Vonage Communications APIs (formerly Nexmo) or Vonage Contact Center.
Administrator access to the Vonage Admin Portal.
Developer credentials for the Vonage Developer Portal. These are separate from your normal Vonage login. Step 1 explains how to get them.
Call recording turned on in Vonage (Company Call Recording or On-Demand Recording). Voxjar can only evaluate calls that Vonage recorded.
Administrative permissions in your Voxjar portal.
Single sign-on: Vonage's APIs authenticate with OAuth, which does not work with SSO. If your Vonage account uses SSO, the API user you create in Step 2 must have SSO turned off. Everything else stays as it is.
Step 1: Get access to the Vonage Developer Portal
Vonage issues Developer Portal accounts on request. Vonage's support site says the program is intended for accounts with 50 or more extensions, so smaller accounts should ask anyway and mention Voxjar.
Contact your Vonage Customer Success Manager or account representative and ask for a VBC API developer account. If you do not have one, open a support case from the Admin Portal.
When approved, you receive a welcome email from Vonage Dev Support with the subject "VBC Developer Center - Welcome" containing your developer credentials.
Sign in at apimanager.uc.vonage.com with those credentials to confirm they work. The portal is titled "APIs for Vonage Business Communications".
Steps 3 to 5 happen in this portal. Step 2 happens in the regular Admin Portal.
Step 2: Create an API user in the Admin Portal
Voxjar signs in to Vonage as a dedicated user rather than as you, so that access can be reviewed or removed without affecting anyone's phone. Vonage calls this an integration user.
Sign in to admin.vonage.com as an administrator.
Go to Phone System > Users and click Add New.
Fill in the user:
First name API, last name USER (any names work; these make the account easy to spot).
Username: Vonage recommends api_user_ followed by your account number, for example api_user_999999. Write down the exact username; you will enter it in Voxjar.
Email address: any monitored mailbox.
User type: Account Administrator. Voxjar needs to list users and search company recordings, which lower roles cannot do.
Extension: choose User does not need an extension.
If you see Enable single sign-on for this user, untick it.
Save the user.
Find the new user in the directory, open it, and choose Update Password. Set a strong password: Vonage asks for at least 20 characters with mixed case, a number, and a special character. Write it down; you will enter it in Voxjar.
Note: Do not sign in to the Vonage desktop or mobile apps with this user. It exists only so Voxjar can authenticate.
Step 3: Create an application in the Developer Portal
An application is how Vonage groups API subscriptions and issues credentials.
Sign in at apimanager.uc.vonage.com with your developer credentials.
Click Applications in the top bar, then Add New Application.
Name it Voxjar and give it a short description such as "AI call evaluator".
For Per Token Quota, choose the highest option offered (Unlimited if available). Voxjar downloads every recording, and a low quota will throttle imports.
Click Save. The application appears in your Applications list.
Step 4: Subscribe the application to the APIs Voxjar uses
Voxjar needs three of Vonage's APIs:
CallRecording: listing and downloading company call recordings. Required.
Reports: call logs (who called, when, duration, direction). Required.
Provisioning: listing users so calls are matched to the right agent. Required.
VonageIntegrationSuite and Telephony: not used by Voxjar. Harmless if already subscribed.
For each required API:
Click APIs in the top bar. You will see one tile per API.
Open the tile (for example CallRecording).
In the left sidebar click My Applications. In the Subscribe section choose Voxjar from the Application drop-down, pick the highest business plan offered (Gold for CallRecording), and click Subscribe.
Repeat for Reports and Provisioning.
To check your work, open Applications, click Voxjar, then Subscriptions. All three APIs should show Lifecycle State PUBLISHED and Subscription Status UNBLOCKED. If a subscription shows a status other than UNBLOCKED, Vonage has not approved it yet; contact your account representative.
Step 5: Get the Client ID and Client Secret
Open Applications, click Voxjar, then Production Keys in the left sidebar.
If no keys exist yet, click Generate Keys.
Under Grant Types, make sure Password is ticked. Voxjar authenticates with the API user's password. Refresh Token and Client Credentials can stay ticked; Code is not needed.
Leave Callback URL as it is. Voxjar does not use a browser redirect, so this value is ignored.
Click Update if you changed anything.
Copy the Consumer Key. In Voxjar this is the Client ID.
Click the eye icon next to Consumer Secret, then copy it. In Voxjar this is the Client Secret.
Step 6: Find your Vonage Account ID
Voxjar needs the numeric Vonage account number to request call logs. It is the same number Vonage suggests you use in the API user's username (api_user_account number). You can also find it in the Admin Portal under your company account details, and on your Vonage invoice. If you are not sure, your Vonage representative can confirm it.
Step 7: Connect in Voxjar
In Voxjar, go to Settings > Integrations.
Find the Vonage tile and click Connect.
Fill in the form:
Integration Nickname: any name, for example "Vonage main office". Shown in Voxjar only.
Vonage Account Id: your Vonage account number (Step 6).
API Username: the API user's username from Step 2, for example api_user_999999. Enter it exactly as created; Voxjar adds the @vbc.prod suffix Vonage requires.
API User Password: the password you set in Step 2.
Client ID: the Consumer Key from Production Keys (Step 5).
Client Secret: the Consumer Secret from Production Keys (Step 5).
Click Connect. Voxjar immediately tests the credentials by signing in as the API user, listing your users, listing company recordings, and reading call logs. If any step fails you will see a message naming the API to check (see Troubleshooting).
Credentials are stored encrypted. Voxjar signs in fresh on each import run, so rotating the API user's password or the application keys only requires updating them in the Voxjar form.
After connecting
Create a queue or import that uses the Vonage integration to choose which calls get evaluated and on what schedule.
Voxjar polls Vonage for new call logs and recordings on the schedule you set. There are no webhooks to register on the Vonage side.
Only calls that Vonage recorded can be evaluated. If a call appears in Vonage's call log without a recording, Voxjar skips it.
Calls are matched to Voxjar agents by the Vonage user on the call. Invite your agents to Voxjar with the same email addresses they use in Vonage so scores land on the right person.
Troubleshooting
"Error getting access token": wrong API username or password, wrong Client ID or Secret, the Password grant type is not enabled on the application, or the API user has SSO enabled. Re-check Steps 2 and 5. Enter the username without @vbc.prod. Confirm Password is ticked under Grant Types.
"Please subscribe to the Provisioning API, check your accountId, and make sure user is allowed to search company users": the application is not subscribed to Provisioning, the account number is wrong, or the API user is not an Account Administrator. See Steps 4, 6, and 2.
"Please subscribe to the CallRecording API, and make sure user is allowed to search company call recordings": no CallRecording subscription, or the API user's role cannot see company recordings. See Steps 4 and 2.
"Please subscribe to the Reports API": no Reports subscription. See Step 4.
Connected, but no calls arrive: call recording is off in Vonage, the queue's filters exclude the calls, or the application's per-token quota is throttling downloads. Confirm recording is enabled in the Admin Portal, widen the queue filters, and raise the quota in Step 3.
Imports stopped after working for a while: the API user's password was changed or expired, the keys were regenerated, or the application was deleted in the Developer Portal. Update the credentials in Voxjar, or recreate the application and re-subscribe.
Vonage's own documentation: VBC API overview · developer account · create an application · subscribe to APIs · create an integration user · VBC APIs support article.