Skip to main content
Skip table of contents


To pair the Vonage connector with a Vonage application you will need an Application ID, Private Key, API Key and API Secret.

Vonage Credentials

Sign in to the Vonage dashboard here if you already have an account. If not create one here.

Application ID and Private Key

  1. Select 'Your applications' from the left hand menu

  2. Either select an existing application or create a new one

  3. Your Application ID will be displayed, make a note of that and then click 'Edit'

  4. Scroll down to where a Public Key is displayed. Click 'Generate public and private key'

  5. The private key should download to your system

  6. Make sure to scroll to the bottom of the page and click 'Save Changes'. Failure to do so will result in authorization errors when making calls to the Vonage API

  7. Open the private key file. Copy all text excluding '-----BEGIN PRIVATE KEY-----' and '-----END PRIVATE KEY-----'. In this screenshot it would be lines 2 - 27

API Key and API Secret

  1. From your account settings you will find your API Key and API Secret

Connector Setup

  1. Locate the Vonage connector

    Cyclr Console > Connectors > Connector Library > Vonage

  2. From the Edit Connector interface click 'Setup'

  3. Enter your Application ID, Private Key, API Key and API Secret. Click 'Next'

The connector is now configured to interact with your Vonage application.

Get Number Details method

When you retrieve information associated with a phone number with the Get Number Details method, you can also retrieve the contact name associated with that phone number. To retrieve the contact name, set the Cnam query parameter to true.

Note: You can only use the Cnam functionality with US phone numbers

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.