Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WASdev/sample.voice.gateway
Lots of helpful samples to help jumpstart development with the IBM Voice Gateway.
https://github.com/WASdev/sample.voice.gateway
Last synced: 15 days ago
JSON representation
Lots of helpful samples to help jumpstart development with the IBM Voice Gateway.
- Host: GitHub
- URL: https://github.com/WASdev/sample.voice.gateway
- Owner: WASdev
- License: apache-2.0
- Created: 2016-11-14T18:45:56.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-07T08:01:35.000Z (about 1 year ago)
- Last Synced: 2024-08-27T21:30:44.222Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 10.8 MB
- Stars: 62
- Watchers: 34
- Forks: 113
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: security/README.md
Awesome Lists containing this project
README
![](./images/VoiceGateway_WebLogo_Color-2.png)
# sample.voice.gateway
This repository contains various samples and scripts to help you get started with the IBM® Voice Gateway™.
IBM® Voice Gateway provides a Session Initiation Protocol (SIP) endpoint that orchestrates IBM® Watson™ speech and conversation services to enable a cognitive agent that communicates with a caller using natural language. The voice gateway makes it possible to integrate a public or enterprise telephony system with Watson, enabling direct voice interactions with a cognitive self-service agent or the ability to access real-time transcriptions of a phone call between two people (e.g. a customer and a contact center agent).
![](./images/vgw-flow.png)
Within this repository you will find the following directories:
| Directory | Description |
| -------------- | --------------------------------------------------------------- |
| **\docker** | Contains sample **docker-compose.yml** files that can be used to launch the voice gateway docker images in your own docker environment.|
| **\bluemix** | Contains scripts and **docker.env** files that can be used to deploy the voice gateway to the IBM® Containers for Bluemix® service.|
| **\conversation** | Contains sample **docker-compose.yml** files that can be used to launch the voice gateway docker images in your own docker environment.|
| **\kubernetes** | Contains contains scripts to help you get started with deployments of the voice gateway into a k8s environment.|
| **\security** | Files to help customize security of the voice gateway.|
| **\audio** | Audio files used in the sample conversation.|
| **\soe** | Sample Service Orchestration Engine used to customize your voice conversation through the use of APIs.|### Pulling the IBM Voice Gateway Docker images
The voice gateway is made up of two separate Docker images that can be pulled using the following command:```
docker pull icr.io/voice-gateway/sip-orchestrator:latestdocker pull icr.io/voice-gateway/media-relay:latest
```
Read more about these images here:
[voice-gateway-so](https://hub.docker.com/r/ibmcom/voice-gateway-so/)[voice-gateway-mr](https://hub.docker.com/r/ibmcom/voice-gateway-mr/)
### Usage
All the documentation related to the Voice Gateway and the use of the samples in this GitHub repository can be found here:[IBM Voice Gateway Documentation](https://www.ibm.com/support/knowledgecenter/SS4U29/welcome_voicegateway.html)
If you want to deploy the voice gateway to IBM Containers on Bluemix, go here:
[Deploying to IBM Containers on Bluemix](https://www.ibm.com/support/knowledgecenter/SS4U29/deploybmix.html)
If you want to deploy the voice gateway to a Docker engine, go here:
[Deploying to Docker Engine](https://www.ibm.com/support/knowledgecenter/SS4U29/deploydocker.html)
If you're interested in setting up the voice gateway behind a Twilio SIP trunk, go here:
[Twilio integration](https://www.ibm.com/support/knowledgecenter/SS4U29/twilio.html)
### Become part of our community!
[](https://ibm-cloud-tech.slack.com/messages/ibmvoicegateway)
[Need an account on ibm-cloud-tech.slack.com? Click here to sign up.](https://slack-invite-ibm-cloud-tech.mybluemix.net/)
### Licenses
The license related to the files found in this GitHub repository:[Apache 2.0 License](https://github.com/WASdev/sample.voice.gateway.for.watson/blob/master/LICENSE)
The license for the IBM® Voice Gateway Docker images can be found here:
[IBM Voice Gateway License](http://www14.software.ibm.com/cgi-bin/weblap/lap.pl?li_formnum=L-MCAO-AJTLXM&popup=n&title=IBM%20Voice%20Gateway)