https://github.com/artificialsolutions/tie-api-example-vonage-sms
Interact with your Teneo bot using SMS. This connector makes use of the Nexmo SMS API.
https://github.com/artificialsolutions/tie-api-example-vonage-sms
chatbot-platform connector nexmo-sms sms-messages teneo teneo-engine
Last synced: 8 months ago
JSON representation
Interact with your Teneo bot using SMS. This connector makes use of the Nexmo SMS API.
- Host: GitHub
- URL: https://github.com/artificialsolutions/tie-api-example-vonage-sms
- Owner: artificialsolutions
- License: apache-2.0
- Created: 2019-10-09T13:56:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T15:58:01.000Z (over 3 years ago)
- Last Synced: 2024-04-28T04:39:48.598Z (about 2 years ago)
- Topics: chatbot-platform, connector, nexmo-sms, sms-messages, teneo, teneo-engine
- Language: JavaScript
- Homepage: https://developers.artificial-solutions.com
- Size: 53.7 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# tie-api-example-vonage-sms
> [!IMPORTANT]
> This project has been retired and archived
> If there is a need of continued use / development of this project for your own needs please feel free to fork the project - which will remain here in archived form.
The Vonage SMS connector enables a Teneo bot to communicate with users by receiving and sending SMS messages. This Node.js connector acts as middleware between Vonage SMS API and a Teneo bot to implement SMS communication with persisting state and conversational position. Visit [Vonage](https://developer.Vonage.com/api/sms) for more information.
## Prerequisites
### Teneo Engine
Your bot needs to be published and you need to know the engine url.
### Vonage SMS API
A [Vonage](https://ui.idp.vonage.com/ui/auth/registration) account with a 'Virtual Phone Number' configured in it.
The steps to setup the account, configure Billing, and buying a virtual number are described ahead.
_Important:_ Adding funds is required to buy a 'Virtual Phone Number'. €10 will suffice to purchase a number and send many SMS messages.
### HTTPS
To run the connector locally, [ngrok](https://ngrok.com/) is preferred to make the connector available via HTTPS.
## Vonage Setup Instructions
To setup communication by SMS between a Teneo bot and Vonage's SMS API follow these steps:
1. Register an account [here](https://ui.idp.vonage.com/ui/auth/registration).
2. Set up Billing
From your new account's dashboard, open [Billing and Payment](https://dashboard.nexmo.com/billing-and-payments).
Set up a payment method and add €10 to your funds. This should be enough to purchase a virtual SMS phone number for around 2€ or €4, and send many SMS messages for a few cents each. [Pricing](https://dashboard.Vonage.com/pricing) varies per country.
3. Buy a 'Virtual Phone Number'
Open the [Buy Number](https://dashboard.nexmo.com/buy-numbers) section your Vonage dashboard.
Select your country to obtain cheaper rates, set 'Features' to `SMS`, set Type to `Mobile`, and click 'Search'.
Choose a number from the list, click `Buy`. Note: The process of buying virtual phone numbers may vary across countries.
4. Ensure that the `HTTP Method` in Vonage's [Default SMS Settings](https://dashboard.nexmo.com/settings) is set to 'POST'.
## Connector Setup Instructions
You could [run the connector locally](#running-the-connector-locally) or to deploy it on a server of your choice. This is preferred if you're familiar with node.js development and want to have a closer look at the code, or implement modifications and enhancements.
### Running the connector locally
The local deployment of this connector allows you to enhance and modify its functionality. To run the connector locally, follow these steps:
1. Download or clone the connector source code:
```
git clone https://github.com/artificialsolutions/tie-api-example-vonage-sms.git && cd tie-api-example-vonage-sms
```
2. Install dependencies by running the following command in the folder where you stored the source:
```
npm install
```
3. Create a file called `.env` in the `tie-api-example-Vonage-sms` folder. Replace the dummy URL with Teneo Engine URL of your bot. "API key" and "API Secret" are found in [Settings](https://dashboard.nexmo.com/settings)
```
TENEO_ENGINE_URL=
NEXMO_API_KEY=
NEXMO_API_SECRET=
NEXMO_NUMBER=
```
4. Start the connector:
```
node server.js
```
Next, we need to make the connector available via https. We'll use [ngrok](https://ngrok.com) for this.
1. Start ngrok. The connector runs on port 1337 by default, so we need to start ngrok like this:
```
ngrok http 1337
```
2. Running the command above will display a public https URL. Copy it, we will use it as a `Incoming Webhook URL` in the step below.
3. Inside your Vonage account's dashboard, [navigate](https://dashboard.nexmo.com/your-numbers) to the Virtual Phone Number you purchased in the previous step, and click on `Manage`. Paste the public https URL provided by ngrok in the `Inbound Webhook URL` field and append it will `/teneochat`. It should look something like this: https://abcd1234.ngrok.io/teneochat.
4. Also [Update your Vonage sms settings](https://dashboard.nexmo.com/settings) under Build & Manage -> API Settings, change Webhook format from a `GET` to a `POST`
That's it! Text your Virtual Phone Number with a mobile phone, and the Teneo bot will send an SMS reply!