Welcome to the Vonage API platform! Vonage provides a suite of APIs that enable you to communicate with your customers using your preferred channels.
This site provides comprehensive documentation for all of our APIs and you’ll find everything you need to know about working with a particular API in the corresponding section.
However, there are some fundamental concepts that you need to understand and tools that might help you that apply across all our APIs. Here, we'll give you this information and get you up and running as quickly as possible.
What you will learn:
- Signing up for an account
- Accessing the Developer Dashboard
- Using the Vonage CLI
- Experimenting with our APIs
- Using a Server SDK
- Working with Webhooks
- Number Format
- What to do next
To work with our APIs, you will need to sign up for an account. This will give you an API key and secret that you can use to access our APIs.
Once you have an account, you can log into the Developer Dashboard. The Developer Dashboard is a GUI-based approach to managing your account, where you can:
- View your API key and secret. You will need these to authenticate your requests to our APIs
- Manage your account balance. Access to our APIs is charged on a per-request basis. We’ll give you some free credit when you first open your account and you can top up when you run low.
- Rent virtual numbers. You can use virtual numbers provided by Vonage to send and receive calls and messages. See rent a virtual number.
- Manage applications. Some of our APIs (such as Voice and Messages) require you to create an Application, which acts as a container for security and configuration information. You can create and manage these applications in the Developer Dashboard.
- Manage your account. You can perform other administration tasks here.
You can optionally perform many of the Dashboard tasks from the command line, using the Vonage CLI. This is often quicker and also allows you to script these operations.
The Vonage CLI is written with
oclif and can be installed using the Node Package Manager (
README in the Vonage CLI GitHub repo shows you how to install and work with the Vonage CLI.
Ultimately, you’re going to want to build an app in your chosen programming language. But to start with, you might want to make some sample requests to our APIs to check that you have provided the correct parameters and that you are getting back the responses you want.
If you are familiar with the command-line tool Curl, you will find Curl snippets for each of our APIs that you can copy, paste and modify.
Various GUI tools exist that are easier to use than Curl. A popular one is Postman. Read our guide on using Postman to work with our APIs. Vonage also provides a set of Postman collections, which provides a way to start using the APIs immediately.
When you are ready to start building your app, you’ll want to use one of our Server SDKs instead of coding each request by hand. We have SDKs for the following programming languages:
Click on the link for your chosen language to visit that SDK’s GitHub repo page, where you can learn how to install and use it.
Once you have learned how to make requests to our APIs to place calls, send messages and so on you will want to learn how to receive inbound communications on your virtual number.
When our APIs want to notify your app about something - whether that is an inbound call or message or a status update - they require your app to expose a URL endpoint that our platform can make a request to. These must be accessible over the public Internet.
These endpoints are called Webhooks. Find out more about webhooks. Once you have created your web hook, you must tell our API platform to use it. The process for doing this depends on which API you are using and full instructions can be found in the documentation for that API.
Making these webhooks publicly-accessible during development can be tricky, so we recommend a tool called Ngrok.
Visit our guide on testing with Ngrok to learn how to use it.
Within the Vonage APIs, all phone numbers are in E.164 format. This means that numbers:
- Omit both a leading
+and the international access code such as
- Contain no special characters, such as space,
For example, a US number would have the format
14155550101. A UK number would have the format
If you are unsure how to format the number, the Number Insight API can be used to find correct information about a number.
See also Number format in the Voice API documentation.
There are a number of shared concepts between the Vonage APIs: the use of JSON Web Tokens (JWTs), signed requests, and webhooks. The guides below explain in detail how to use these elements.
- Applications - Security and configuration information you need to connect to Vonage endpoints.
- Authentication – API keys and JSON Web Tokens (JWTs).
- Signing messages – how to cryptographically sign messages and verify message signatures.
- Webhooks – Vonage's API can send data back to your web server via a webhook.
- OpenAPI – All Vonage APIs have OpenAPI descriptions that you can take advantage of in your own development process.
- Glossary – A glossary of common terms used throughout the Vonage platform.
This guide introduced you to some of the fundamental concepts and tools that you should know about when working with our APIs.
Learn more in our SDKs and Tools section.
Once you understand these fundamental concepts and have installed the tools you intend to use, you are ready to start building! View the documentation for your chosen API to get started, or try out some of the following starter tasks:
- SMS API: Send an SMS
- Voice API: Make an outbound call with an NCCO
- Verify API: Send and then check a verification request.
- Messages API: Send a message using Facebook Messenger
If you encounter any difficulties, check out our knowledge base and reach out for assistance if necessary at our support site.
We take pride in our documentation, but are always looking to make it better. So if you find anything that is unclear or lacking the information you require, then please submit feedback for the topic in question. If we’ve done a good job on a particular section then please let us know!