Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nexmo-community/sms-ibm-sentiment-php
PHP example using IBM Watson Tone Analysis to analyze SMS messages and determine the sentiment of the text.
https://github.com/nexmo-community/sms-ibm-sentiment-php
extend nexmo php sentiment-analysis sms sms-message watson-tone-analyzer
Last synced: 22 days ago
JSON representation
PHP example using IBM Watson Tone Analysis to analyze SMS messages and determine the sentiment of the text.
- Host: GitHub
- URL: https://github.com/nexmo-community/sms-ibm-sentiment-php
- Owner: nexmo-community
- License: mit
- Created: 2019-09-23T22:12:28.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-01-31T05:32:39.000Z (11 months ago)
- Last Synced: 2024-05-02T01:02:13.728Z (8 months ago)
- Topics: extend, nexmo, php, sentiment-analysis, sms, sms-message, watson-tone-analyzer
- Language: PHP
- Homepage: https://developer.nexmo.com/extend/ibm-watson-speech-to-text
- Size: 45.9 KB
- Stars: 0
- Watchers: 11
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SMS Sentiment Analysis with IBM Tone Analyzer using PHP
[](https://nexmo.dev/sms-ibm-sentiment-php-heroku)
PHP script for callback to return sentiment analysis from the IBM Tone Analyzer to grade the contents of an SMS message sent through a Nexmo number. This example script uses Composer to include slim/slim, slim/psr7, guzzlehttp/guzzle, and vlucas/phpdotenv.
## IBM Tone Analyzer Service
Reference: [https://www.ibm.com/watson/services/tone-analyzer/](https://www.ibm.com/watson/services/tone-analyzer/)
API Docs: [https://cloud.ibm.com/apidocs/tone-analyzer](https://cloud.ibm.com/apidocs/tone-analyzer)
GitHub: [https://github.com/watson-developer-cloud/node-sdk#tone-analyzer](https://github.com/watson-developer-cloud/node-sdk#tone-analyzer)
Register for the [IBM Tone Analyzer service](https://console.bluemix.net/catalog/services/tone-analyzer). Once created, make a note of the API Key and URL for use later. These can be found in the Manage page of the IBM Cloud dashboard after login.
---
**Note for IBM Cloud deploy**: Once the app has deployed, go to the app dashboard and update the environment variables with these credentials under "Runtime > Environment Variables"
---
## Running the App
This sample app uses a `.env` file to provide the API key and URL to the IBM Tone Analyzer API.
Copy the provided `.env.example` file to a new file called `.env`:
```
cp .env.example > .env
```
Then update the values with those from the IBM Tone Analyzer service Manage page, and then save.
```
TONE_ANALYZER_IAM_APIKEY=
TONE_ANALYZER_URL=
```
Also, expose the application to the internet using tools like [ngrok](https://ngrok.com/). To see how, [check out this guide](https://www.nexmo.com/blog/2017/07/04/local-development-nexmo-ngrok-tunnel-dr/).
### Use Composer to install dependencies
Both methods of serving the app, shown below, do require the use of Composer to install dependencies and set up the autoloader.
Assuming a Composer global installation. [https://getcomposer.org/doc/00-intro.md#globally](https://getcomposer.org/doc/00-intro.md#globally)
```
composer install
```
#### Docker Method
To run the app using Docker-Compose, run the following command in a terminal:
```
docker-compose up
```
This will create a new container and serve it from http://localhost:8080.
#### PHP Built-in Webserver Method
Alternatively, it can be ran using the PHP built-in web server for testing purposes. This method requires us to run Composer for installation of dependencies.
##### Launching the PHP built-in webserver
To serve the app run the following command in a terminal:
```
php -S localhost:8080
```
## 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](https://github.com/Nexmo/nexmo-cli#installation).
### 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 PHP application running in the terminal, send various SMS messages to the virtual number. The terminal will output the response from IBM Tone Analyzer.
## Extend
This app prints out to the console. For integration with an application, extend the `analyzeTone` function to suit your needs.