Repository files navigation

Quickstarts also available for:

• Kotlin
• Python
• .NET
• Node.js
• PHP
• Ruby
• 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 forhttps://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 aVonage account.

For some of the examples you will need tobuy a number.

You will need to haveGradle installed to build the code. Once you have Gradle installed,run the following to build a jar that contains the quickstart code along with alltheVonage 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 thosevalues into environment variables, so you'll probably want to use a tool likeForeman 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 variableQUICKSTART_DEBUG to any value, extra informationwill be output to the console from the Vonage Server SDK.

Sign up for a freengrok account

Download and install from the ngrok site or use Homebrew (mac0S)

brew install cask ngrok

1. Go to your ngrok dashboard.
2. Go to Setup & Installation
3. Copy the token from theConnect your account step without the./ prefix. What you copy should look like this:

ngrok authentication 112skjl4jlwlkjdl4lkj66565lkjmn56n==e4w4l

4. Start a HTTP tunnel forwarding to your local port. Check your snippet to locate the port ngrok should forward to.For the Voice NCCO snippets we use port 3000, so our command would be:

ngrok http 3000

You may then enterhttp://localhost:4040/inspect/http in your web browser to see a more detailed view of your requests, or use theconsole to http status and message of your requests.

After setting upngrok you will need to setup a Vonage application that will be used for monitoring your webhooks. Add a vonage featurethat 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 theVonage Developer Portal

1. On the developer portal, go to Applications.
2. Click on theCreate new application button.
3. Give your applications a name.
4. UnderCapabilities, toggle theVoice capability.Go back to the terminal that has ngrok fired up and grab the forwarding url. Add that domain as the prefix to the path for thewebhook. Resulting url should look similar to the following:

 http://17e80b46d273.ngrok.io/webhook/answer

Go back to theVoice 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)

5. Click thegenerate public and private key button. A private key file called private.key should be downloaded to your computer.
6. Move the private key to the nexmo-java-code-snippets project root.
7. Go the developer portal and clickGenerate application
8. In your.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 theapplication id, andprivate key file location
9. (Optional) Link the number associated with your nexmo account to your app. In the developer portal, click the Link buttonon the application details screen to link that number to your application. This will allow you to test webhooks that require you tocall or text a number to test the NCCOs for that snippet.

Pleaseraise an issue to request an example that isn't present within the quickstart. Pull requests will be gratefully received.

This code is licensed under theMIT license.