https://github.com/nexmo/nexmo-converseai
Nexmo Plugin for Converse.ai
https://github.com/nexmo/nexmo-converseai
2fa ai artificial-intelligence nexmo plugin sms
Last synced: over 1 year ago
JSON representation
Nexmo Plugin for Converse.ai
- Host: GitHub
- URL: https://github.com/nexmo/nexmo-converseai
- Owner: Nexmo
- License: mit
- Created: 2017-09-30T14:07:55.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2025-03-21T05:31:41.000Z (over 1 year ago)
- Last Synced: 2025-03-21T06:27:42.407Z (over 1 year ago)
- Topics: 2fa, ai, artificial-intelligence, nexmo, plugin, sms
- Language: JavaScript
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 13
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nexmo Plugin for Converse AI
A Nexmo plugin for [Converse AI](https://converse.ai).
The plugin presently supports:
* Sending an SMS Message
* Send a Verify PIN code
* Check a Verify PIN code
## Installation
Clone the Nexmo plugin
```bash
git clone git@github.com:Nexmo/nexmo-converseai.git
cd nexmo-converseai
```
Create a `.env` file by copying the existing `example.env`:
```bash
cp example.env .env
```
Fill out the configuration values. In order to do this you will need a [Nexmo](https://nexmo.com) account and you may also need to buy a phone number from Nexmo via the Nexmo dashboard.
Deploy the plugin to your Converse AI account:
```bash
converse-cli deploy
```
## Development
See the Converse AI documentation on [plugin development](https://get.converse.ai/docs/plugin-development).
### Configuration for Testing
Create a `.env` file by copying the existing `example.env`:
```bash
cp example.env .env
```
Fill out the configuration values.
### Running Tests
Run the test and have your phone standing by.
```bash
npm test
```
Tests are run via `test/modules/all.js` to ensure the sequence of the tests.
Some of the tests are commented out since test are run upon deployment of the Nexmo plugin (via running `converse-cli deploy`) but the test reply on collecting data from the terminal and you cannot do that during the deployment process.
## License
[MIT](LICENSE)