https://github.com/symblai/twilioflex-inbound-adapter
A sample app with starter code for implementing Twilio Media Streams over Symbl.ai's WebSocket Streaming API. Build your own custom, fully programmable continuous conversation intelligence application.
https://github.com/symblai/twilioflex-inbound-adapter
100daysofcode amazon api aws chime media-streaming-demo sentiment starter-code symbl transcription twilio websocket websockets
Last synced: 3 months ago
JSON representation
A sample app with starter code for implementing Twilio Media Streams over Symbl.ai's WebSocket Streaming API. Build your own custom, fully programmable continuous conversation intelligence application.
- Host: GitHub
- URL: https://github.com/symblai/twilioflex-inbound-adapter
- Owner: symblai
- License: mit
- Created: 2020-03-05T21:59:13.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T03:59:24.000Z (over 2 years ago)
- Last Synced: 2024-05-28T18:06:06.640Z (about 1 year ago)
- Topics: 100daysofcode, amazon, api, aws, chime, media-streaming-demo, sentiment, starter-code, symbl, transcription, twilio, websocket, websockets
- Language: JavaScript
- Homepage:
- Size: 12.9 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Twilio Flex Inbound Adapter
[](https://docs.symbl.ai/docs/streamingapi/overview/introduction)
Symbl's APIs empower developers to enable:
- **Real-time** analysis of free-flowing discussions to automatically surface highly relevant summary discussion topics, contextual insights, suggestive action items, follow-ups, decisions, and questions.
- **Voice APIs** that makes it easy to add AI-powered conversational intelligence to either [telephony][telephony] or [WebSocket][websocket] interfaces.
- **Conversation APIs** that provide a REST interface for managing and processing your conversation data.
- **Summary UI** with a fully customizable and editable reference experience that indexes a searchable transcript and shows generated actionable insights, topics, timecodes, and speaker information.
## Enable Symbl for Twilio Flex Calls
* [Setup](#setup)
* [Integration](#integration)
* [Conclusion](#conclusion)
* [Community](#community)
## Introduction
This is a sample implementation of Symbl's Websocket API using Twilio Flex as an inbound adapter for streaming audio. These instructions use Twilio Media Streams configured in the Twilio Studio and ngrok to expose a local endpoint.
## Setup
The first step to getting setup is to [sign up][signup].
Update the .env file with the following:
1. Your App Id that you can get from [Platform](https://platform.symbl.ai)
2. Your App Secret that you can get from [Platform](https://platform.symbl.ai)
3. Your email address where the conversation summary and insights will be sent.
4. Your name to be attached to conversation summary
In a new terminal, run `ngrok http 3000` to create a http tunnel to allow Twilio to hit the websocket server. If you plan to deploy this server, then you don't need to use ngrok and instead just have to configure Twilio Media Streams endpoint to hit the deployed server.
Configure your Twilio Flex flow using `Media Streams` - Follow the "Setting Up your Twilio Studio" with your ngrok or server endpoint from this [blog post](https://symbl.ai/integrating-symbl-insights-with-twilio-media-streams/)
Run the follwing npm commands:
1. `npm install` to download all the node modules
2. `node index.js` to start the websocket server
## Integration
### Pre-requisites
* JS ES6+
* Node.js
* npm (or your favorite package manager)
* ngrok - free accounts at https://ngrok.com/ (or a deployed server)
* Twilio account w/ Flex and Studio features included - https://www.twilio.com/try-twilio
### Function Parameters
Function params passed to the Symbl [Streaming API](https://docs.symbl.ai/docs/streamingapi/overview/introduction) to open the websocket connection can be found beginning on line 71 of the index.js file.
```javascript
client_connection.send(JSON.stringify({
"type": "start_request",
"insightTypes": ["question", "action_item"],
"config": {
"confidenceThreshold": 0.5,
"timezoneOffset": 480, // Your timezone offset from UTC in minutes
"languageCode": "en-US",
"speechRecognition": {
"encoding": "MULAW", // Codec required for Twilio Flex
"sampleRateHertz": 8000 // Make sure the correct sample rate is
},
"meetingTitle": "Customer Call"
},
"speaker": {
"userId": process.env.USER_EMAIL,
"name": process.env.USER_NAME
},
}));
```
### Dependencies
```json
"dependencies": {
"dotenv": "^8.2.0",
"express": "^4.17.1",
"http": "0.0.0",
"mic": "^2.1.2",
"path": "^0.12.7",
"request": "^2.88.2",
"websocket": "^1.0.31",
"ws": "^7.2.1"
}
```
### References
Configured Twilio Studio flow
## Conclusion
When implemented once a Twilio Flex agents answers a new call, the call will connect with Symbl and the the conversation + insights will be generated and sent via email when the call is closed.
## Community
If you have any questions, feel free to reach out to us at [email protected], through our Community [Slack][slack], or [developer community][developer_community]
This guide is actively developed, and we love to hear from you! Please feel free to [create an issue][issues] or [open a pull request][pulls] with your questions, comments, suggestions and feedback. If you liked our integration guide, please star our repo!
This library is released under the [MIT License][license]
[license]: LICENSE.txt
[telephony]: https://docs.symbl.ai/docs/telephony/overview/post-api
[websocket]: https://docs.symbl.ai/docs/streamingapi/overview/introduction
[developer_community]: https://community.symbl.ai/?_ga=2.134156042.526040298.1609788827-1505817196.1609788827
[signup]: https://platform.symbl.ai/?_ga=2.63499307.526040298.1609788827-1505817196.1609788827
[issues]: https://github.com/symblai/symbl-for-zoom/issues
[pulls]: https://github.com/symblai/symbl-for-zoom/pulls
[slack]: https://join.slack.com/t/symbldotai/shared_invite/zt-4sic2s11-D3x496pll8UHSJ89cm78CA