Quickstarts also available for: Python, .NET, Node.js, PHP, Ruby and curl.
The purpose of the quickstart guide is to provide simple examples focused on one goal. For example, sending an SMS, handling an incoming SMS webhook, making a Text to Speech call. These code samples are meant to be used for https://developer.vonage.com/, and are structured in such a way as to be used for internal testing. Developers are free to use these code snippets as a reference, but these may require changes to be worked into your specific application. We recommend checking out the Vonage Developer Website, which displays these code snippets in a more copy/paste fashion.
To use this sample you will first need a Vonage account.
For some of the examples you will need to buy a number.
You will need to have Gradle installed to build the code. Once you have Gradle installed, run the following to build a jar that contains the quickstart code along with all the Vonage Java Server SDK dependencies:
gradle assemble
This will build the following file: build/libs/vonage-java-code-snippets-with-dependencies.jar
Copy .env-example
to .env
and edit the values. You'll need to load those
values into environment variables, so you'll probably want to use a tool like
Foreman to run your code like this:
foreman run java -cp build/libs/vonage-java-code-snippets-with-dependencies.jar PACKAGE.CLASS
So to run the OutboundTextToSpeechExample class, you would run the following:
foreman run java -cp build/libs/vonage-java-code-snippets-with-dependencies.jar com.vonage.quickstart.voice.OutboundTextToSpeech
If you set the environment variable QUICKSTART_DEBUG
to any value, extra information
will be output to the console from the Vonage Server SDK.
Sign up for a free ngrok account
Download and install from the ngrok site or use Homebrew (mac0S)
brew install cask ngrok
./
prefix. What you copy should look like this:
ngrok authentication 112skjl4jlwlkjdl4lkj66565lkjmn56n==e4w4l
ngrok http 3000
You may then enter http://localhost:4040/inspect/http
in your web browser to see a more detailed view of your requests, or use the
console to http status and message of your requests.
After setting up ngrok
you will need to setup a Vonage application that will be used for monitoring your webhooks. Add a vonage feature
that you would like your webhook to monitor for. In this example, we will setup a Vonage application and add voice capabilities.
Setup a Vonage Application with voice capabilities using the Vonage Developer Portal
http://17e80b46d273.ngrok.io/webhook/answer
Go back to the Voice capabilities section and add the urls for the webhooks. Ex:
Answer URL: http://17e80b46d273.ngrok.io/webhook/answer
Event URL: http://17e80b46d273.ngrok.io/webhook/event
Answer Fallback URL: http://17e80b46d273.ngrok.io/webhook/fallback (if no path is specified in the snippet use a random domain)
.env
file, add the environment variables for your application that is needed to run the snippet to. For the voice dtmf webhook snippet,
we would need the application id, and private key file location Please raise an issue to request an example that isn't present within the quickstart. Pull requests will be gratefully received.
This code is licensed under the MIT license.