You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-13Lines changed: 18 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,11 @@
1
-
# Nexmo Node.js Skeleton Application
1
+
# Vonage Node.js Skeleton Application
2
+
3
+
<imgsrc="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg"height="48px"alt="Nexmo is now known as Vonage" />
4
+
5
+
This repository is an Express 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 Vonage receives API requests from your account.
This repository is an Express application to test and debug your Nexmo 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 Nexmo receives API requests from your account.
4
9
5
10
*[Requirements](#requirements)
6
11
*[Installation and Usage](#installation-and-usage)
@@ -17,9 +22,9 @@ This application requires that you have the following installed locally:
Additionally, to test your Nexmo account, you must have a Nexmo account. You can create a Nexmo account for free or manage your Nexmo account details at the [Nexmo Dashboard](https://dashboard.nexmo.com).
27
+
Additionally, 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](https://dashboard.nexmo.com).
Alternatively, you could also first fork your copy of this repository to your GitHub profile and then clone your forked copy.
33
38
34
-
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 Nexmo account.
39
+
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.
35
40
36
41
### API Credentials
37
42
38
43
To test your API credentials, rename the provided `.env.example` file to `.env` and supply the values for the following environment variable keys:
39
44
40
-
*NEXMO_API_KEY=
41
-
*NEXMO_API_SECRET=
45
+
*VONAGE_API_KEY=
46
+
*VONAGE_API_SECRET=
42
47
* FROM_NUMBER=
43
48
* TO_NUMBER=
44
49
45
-
The `NEXMO_API_KEY` and `NEXMO_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 [Nexmo provisioned virtual phone number](https://developer.nexmo.com/numbers/overview). The `TO_NUMBER` is the number you wish to send the test SMS message to. This could be your cell phone number.
50
+
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](https://developer.nexmo.com/numbers/overview). The `TO_NUMBER` is the number you wish to send the test SMS message to. This could be your cell phone number.
46
51
47
52
As always, make sure not to 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.
48
53
49
54
### Using ngrok
50
55
51
-
To test the incoming webhook data from Nexmo, the Nexmo API needs an externally accessible URL to send that data to. Commonly used service for development and testing is ngrok. The service provides you with an externally available web address that creates a secure tunnel to your local environment. The [Nexmo Developer Platform](https://developer.nexmo.com/concepts/guides/testing-with-ngrok) has a guide to getting started with testing with ngrok.
56
+
To test the incoming webhook data from Vonage, the Vonage API needs an externally accessible URL to send that data to. Commonly used service for development and testing is ngrok. The service provides you with an externally available web address that creates a secure tunnel to your local environment. The [Vonage Developer Platform](https://developer.nexmo.com/concepts/guides/testing-with-ngrok) has a guide to getting started with testing with ngrok.
52
57
53
-
Once you have your ngrok URL, you can enter your [Nexmo Dashboard](https://dashboard.nexmo.com) and supply it as the `EVENT URL` for any Nexmo 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:
58
+
Once you have your ngrok URL, you can enter your [Vonage Dashboard](https://dashboard.nexmo.com) 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:
54
59
55
60
`#{ngrok URL}/webhooks/event`
56
61
57
-
You can then call your Nexmo Voice application. With your skeleton application running, you can observe the webhook data being received in real-time for the diagnosis of any issues and testing of your Nexmo account.
62
+
You can then call your Vonage Voice application. With your skeleton application running, you can observe the webhook data being received in real-time for the diagnosis of any issues and testing of your Vonage account.
58
63
59
64
### Running the Application
60
65
@@ -64,9 +69,9 @@ Once you have your API credentials incorporated and your ngrok setup ready, you
64
69
npm start
65
70
```
66
71
67
-
You 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 number, you should receive a text message shortly after that says: "This is a test SMS of my Nexmo Node.js skeleton app.".
72
+
You 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 number, you should receive a text message shortly after that says: "This is a test SMS of my Vonage Node.js skeleton app.".
68
73
69
-
The skeleton app is also capable of receiving Nexmo API webhook data. As mentioned in the [Using ngrok](#using-ngrok) section above, a good candidate for that test is a Nexmo Voice application. From within your Nexmo dashboard you can create a Nexmo Voice application, provision a Nexmo 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 Nexmo 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:
74
+
The skeleton app is also capable of receiving Vonage API webhook data. As mentioned in the [Using ngrok](#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:
0 commit comments