Make an outbound call
This code snippet makes an outbound call and plays a text-to-speech message when the call is answered.
Prerequisites
Create an Application
Check out Getting Started with Vonage CLI for more information on how to install and configure the CLI.
Use the following command to create a Vonage application:
Once you have the application, you then need to add the voice capabilities; make sure you replace the webhook URLs with your own:
The application is then created and has the required capabilities. Creating an application and adding application capabilities are covered in detail in the application overview.
Go to the Application's page on the Dashboard, and define a Name for your Application.
Make sure to click on the Generate public and private key button, and keep the file private.key around.
Then, enable the Voice capability. For the moment, leave everything by default.
Finally, click Save at the bottom of the page.
Rent a Number
You can rent a number using the Vonage CLI. The following command searches for an available number in the United States:
Use this command to purchase a number:
Specify an alternative two-character country code to purchase a number in another country.
In the Dashboard, go to the Buy Numbers page. Make sure to tick Voice in the search filter, and select the country you want to buy a number in.
You can then click the Buy button next to the number you want, and validate your purchase.
Congratulations! Your virtual number is now listed in Your Numbers
Link a Number
Now that you have both an application and a number, you need to link them together.
Now that you have both an application and a number, you need to link them together.
Go to the Application page, and click on the application you created earlier.
In the Voice section, click on the Link button next to the number you want to link.
Example
Replace the following variables in the example code:
| Key | Description |
|---|---|
VONAGE_VIRTUAL_NUMBER | Your Vonage Number. E.g. |
VOICE_TO_NUMBER | The recipient number to call, e.g. |
VOICE_ANSWER_URL | The answer URL. For example |
Prerequisites
Execute the following command at your terminal prompt to create the JWT for authentication:
Run your code
Save this file to your machine and run it:
Prerequisites
Create a file named make-an-outbound-call.js and add the following code:
Run your code
Save this file to your machine and run it:
Prerequisites
Add the following to build.gradle:
Create a file named OutboundTextToSpeechCall and add the following code to the main method:
Write the code
Add the following to the main method of the OutboundTextToSpeechCall file:
Run your code
We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:
Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.voice with the package containing OutboundTextToSpeechCall:
Prerequisites
Add the following to build.gradle:
Create a file named OutboundTextToSpeech and add the following code to the main method:
Write the code
Add the following to the main method of the OutboundTextToSpeech file:
Run your code
We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:
Run the following gradle command to execute your application, replacing com.vonage.quickstart.voice with the package containing OutboundTextToSpeech:
Prerequisites
Prerequisites
Run your code
Save this file to your machine and run it:
Prerequisites
Run your code
Save this file to your machine and run it:
Prerequisites
Run your code
Save this file to your machine and run it:
Try it out
When you run the code the TO_NUMBER will be called and a text-to-speech message
will be heard if the call is answered.
Further Reading
- Voice Notifications - In this guide, you will learn how to contact a list of people by phone, convey a message, and see who confirmed that they had received the message. These voice-based critical alerts are more persistent than a text message, making your message more likely to be noticed. Additionally, with the recipient confirmation, you can be sure that your message made it through.
- Conference Calling - This guide explains the two concepts Vonage associates with a call, a leg and a conversation.
- Voice Bot with Google Dialogflow - This guide will help you to start with an example Dialogflow bot and interact with it from phone calls using provided sample reference codes using Vonage Voice API.