Sinatra application to test and debug your Vonage credentials and environment. Utilize this application to test that your API credentials are in working order and to examine the event webhook data you receive when API requests are received by Vonage from your account.
This application requires that you have the following installed locally:
Additionally, in order to test your Vonage account, you must have a Vonage account. You can create a Vonage account for free or manage your Vonage account details at the Vonage Dashboard.
You can run this application by first cloning this repository locally:
git clone [email protected]:Nexmo/ruby-skeleton-app.gitAlternatively, you could also first fork your own copy of this repository to your GitHub profile and then clone your own forked copy.
Once you have downloaded a local copy, change into the directory of the application in your terminal. You can now set up the application for your Vonage account.
In order to test your API credentials, rename the provided .env.sample file to .env and supply the values for the following environment variable keys:
- VONAGE_API_KEY=
- VONAGE_API_SECRET=
- FROM_NUMBER=
- TO_NUMBER=
The VONAGE_API_KEY and VONAGE_API_SECRET are to be provided with your API key and secret, respectively. The FROM_NUMBER is the number you wish the test SMS message to originate from. For example, this could be your Vonage provisioned virtual phone number. The TO_NUMBER is the number you wish to send the test SMS message to. This could be your own cell phone number.
As always, make sure to not commit your sensitive API credential data to any public version control. If you are using Git, you can add the .env file to your .gitignore file to ensure that it is not committed.
In order to test the incoming webhook data from Vonage, the Vonage API needs an externally accessible URL to send that data to. A commonly used service for development and testing is ngrok. The service will provide you with an externally available web address that creates a secure tunnel to your local environment. The Vonage Developer Platform has a guide to getting started with testing with ngrok.
Once you have your ngrok URL, you can enter your Vonage Dashboard and supply it as the EVENT URL for any Vonage service that sends event data via a webhook. A good test case is creating a Voice application and providing the ngrok URL in the following format as the event url:
#{ngrok URL}/webhooks/event
You can then call your Vonage Voice application, and with your skeleton application running you can observe the webhook data be received in real time for diagnosis of any issues and testing of your Vonage account.
Once you have your API credentials incorporated and your ngrok setup ready, you can go ahead and use this skeleton app. To start the application's server, run the following from the command line inside the directory of the app:
ruby app.rbYou can test that your credentials work by sending a test SMS by navigating to https://localhost:3000/test-sms in your browser or by sending a cURL GET request to that URL. If you configured your TO_NUMBER to be your own number, you should receive a text message shortly after that says: "This is a test SMS of my Vonage Ruby skeleton app.".
The skeleton app is also capable of receiving Vonage API webhook data. As mentioned in the Using ngrok section above, a good candidate for that test is a Vonage Voice application. From within your Vonage dashboard you can create a Vonage Voice application, provision a Vonage virtual phone number and then link that number to your Voice application. Once you have ensured that your new Voice application's EVENT URL is #{ngrok URL}/webhooks/event, you can then give your Vonage number a phone call. You should see the webhook data in your console in real time. For example, data for a ringing phone call will look like this:
{:from=>"447700900000", :to=>"447700900000", :uuid=>"a123456789012345fbdsw", :conversation_uuid=>"CON-234567-fdsfs34-vfddfh-btger3-22345", :status=>"ringing", :direction=>"inbound", :timestamp=>"2020-01-07T11:24:49.478Z"}
You can exit your application at anytime by holding down the CTRL and C keys on your keyboard.
We ❤️ contributions from everyone! Bug reports, bug fixes and feedback on the application is always appreciated. Look at the Contributor Guidelines for more information and please follow the GitHub Flow.
This projet is under the MIT License