{"id":25053687,"url":"https://github.com/artificialsolutions/tie-api-example-vonage-sms","last_synced_at":"2025-10-21T10:30:15.873Z","repository":{"id":44061872,"uuid":"213932777","full_name":"artificialsolutions/tie-api-example-vonage-sms","owner":"artificialsolutions","description":"Interact with your Teneo bot using SMS. This connector makes use of the Nexmo SMS API.","archived":false,"fork":false,"pushed_at":"2023-01-11T15:58:01.000Z","size":55,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-28T04:39:48.598Z","etag":null,"topics":["chatbot-platform","connector","nexmo-sms","sms-messages","teneo","teneo-engine"],"latest_commit_sha":null,"homepage":"https://developers.artificial-solutions.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/artificialsolutions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-09T13:56:13.000Z","updated_at":"2024-04-28T04:39:48.599Z","dependencies_parsed_at":"2023-02-09T03:46:01.974Z","dependency_job_id":null,"html_url":"https://github.com/artificialsolutions/tie-api-example-vonage-sms","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artificialsolutions%2Ftie-api-example-vonage-sms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artificialsolutions%2Ftie-api-example-vonage-sms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artificialsolutions%2Ftie-api-example-vonage-sms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artificialsolutions%2Ftie-api-example-vonage-sms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/artificialsolutions","download_url":"https://codeload.github.com/artificialsolutions/tie-api-example-vonage-sms/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237468904,"owners_count":19315033,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatbot-platform","connector","nexmo-sms","sms-messages","teneo","teneo-engine"],"created_at":"2025-02-06T11:50:48.345Z","updated_at":"2025-10-21T10:30:15.255Z","avatar_url":"https://github.com/artificialsolutions.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tie-api-example-vonage-sms\n\n\u003e [!IMPORTANT]\n\u003e This project has been retired and archived  \n\u003e 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.\n\nThe 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.\n\n## Prerequisites\n### Teneo Engine\nYour bot needs to be published and you need to know the engine url.\n\n### Vonage SMS API\nA [Vonage](https://ui.idp.vonage.com/ui/auth/registration) account with a 'Virtual Phone Number' configured in it.\nThe steps to setup the account, configure Billing, and buying a virtual number are described ahead.\n\n_Important:_ Adding funds is required to buy a 'Virtual Phone Number'. €10 will suffice to purchase a number and send many SMS messages.\n\n### HTTPS\n\nTo run the connector locally, [ngrok](https://ngrok.com/) is preferred to make the connector available via HTTPS.\n\n## Vonage Setup Instructions\nTo setup communication by SMS between a Teneo bot and Vonage's SMS API follow these steps:\n1. Register an account [here](https://ui.idp.vonage.com/ui/auth/registration).\n2. Set up Billing\n    From your new account's dashboard, open [Billing and Payment](https://dashboard.nexmo.com/billing-and-payments).\n    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.\n3. Buy a 'Virtual Phone Number'\n    Open the [Buy Number](https://dashboard.nexmo.com/buy-numbers) section your Vonage dashboard.\n    Select your country to obtain cheaper rates, set 'Features' to `SMS`, set Type to `Mobile`, and click 'Search'.\n    Choose a number from the list, click `Buy`. Note: The process of buying virtual phone numbers may vary across countries.\n4. Ensure that the `HTTP Method` in Vonage's [Default SMS Settings](https://dashboard.nexmo.com/settings) is set to 'POST'.\n  \n\n## Connector Setup Instructions\nYou 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.\n\n### Running the connector locally\nThe local deployment of this connector allows you to enhance and modify its functionality. To run the connector locally, follow these steps:\n\n1. Download or clone the connector source code:\n    ```\n    git clone https://github.com/artificialsolutions/tie-api-example-vonage-sms.git \u0026\u0026 cd tie-api-example-vonage-sms\n    ```\n2. Install dependencies by running the following command in the folder where you stored the source:\n    ```\n    npm install\n    ``` \n3. 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)\n    ```\n    TENEO_ENGINE_URL=\u003cyour_engine_url\u003e\n    NEXMO_API_KEY=\u003cyour API key\u003e\n    NEXMO_API_SECRET=\u003cyour API Secret 1\u003e\n    NEXMO_NUMBER=\u003cVirtual Phone Number in E.164 format\u003e\n    ```\n4. Start the connector:\n    ```\n    node server.js\n    ```\n\nNext, we need to make the connector available via https. We'll use [ngrok](https://ngrok.com) for this.\n\n1. Start ngrok. The connector runs on port 1337 by default, so we need to start ngrok like this:\n    ```\n    ngrok http 1337\n    ```\n2. 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.\n3. 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. \n4. Also [Update your Vonage sms settings](https://dashboard.nexmo.com/settings) under Build \u0026 Manage -\u003e API Settings, change Webhook format from a `GET` to a `POST`\n\nThat's it! Text your Virtual Phone Number with a mobile phone, and the Teneo bot will send an SMS reply!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartificialsolutions%2Ftie-api-example-vonage-sms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartificialsolutions%2Ftie-api-example-vonage-sms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartificialsolutions%2Ftie-api-example-vonage-sms/lists"}