Skip to content

nexmo-community/sms-aws-sentiment-js

Repository files navigation

SMS Sentiment Analysis with AWS Comprehend

Deploy to Heroku

This example uses AWS Comprehend to analyze SMS messages and determine the sentiment of the text.

SMS Messages sent through Nexmo will be sent to AWS Comprehend and a series of scores and tones returned to the console.

AWS Comprehend

Create an IAM user with the ComprehendFullAccess policy attached. Copy the IAM user Access Key ID, Secret Access Key, and the AWS region being used.

Running the App

This sample app uses a .env file to provide the API key and URL.

Copy the provided .env.example file to a new file called .env:

cp .env.example > .env

Then update the values with those from the AWS Comprehend enabled IAM user, and then save.

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_REGION=

Also, expose the application to the internet using tools like ngrok. To see how, check out this guide.

Using Docker

To run the app using Docker, run the following command in a terminal:

docker-compose up

This will create a new image with all the dependencies and run it at http://localhost:3000.

Using Node

To run the app using node, run the following command in a terminal:

npm install && node index.js

This will install all the dependencies and run it at http://localhost:3000.

Linking the app to Nexmo

For this example app a Nexmo number and SMS webhook setup is needed.

This can be achieved with the Nexmo CLI. Install the CLI by following these instructions.

Rent a New Virtual Number

Renting a number will need to be in place. This can also be achieved using the CLI by running this command:

nexmo number:buy --country_code US

Adding the SMS Webhook

Update the number created with the URL of the hosted or local server.

nexmo link:sms phone_number https://my-hostname/message

Try it out

With the example Node application running in the terminal, send various SMS messages to the virtual number. The terminal will output the response from AWS Comprehend.

Extend

This app prints out to the console. For integration with an application, extend the analyzeTone function to suit your needs.