Metadata-Version: 2.1
Name: rasa-audiocodes
Version: 0.4.0
Summary: Integrate Rasa with AudioCodes VoiceAI Connect
Home-page: https://github.com/ac-voice-ai/rasa-audiocodes
Author: AudioCodes Ltd.
Author-email: yaakov.bivas@audiocodes.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/ac-voice-ai/rasa-audiocodes/issues
Project-URL: Source, https://github.com/ac-voice-ai/rasa-audiocodes
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: Apache Software License
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# AudioCodes VoiceAI Connect Channel for Rasa

AudioCodes VoiceAI Connect is an application that enables telephony access
for chatbots.

The Rasa integration is using a REST protocol named
[AC-Bot-API](https://techdocs.audiocodes.com/voice-ai-gateway/api/version-180/#VAIG_API/API_1.htm).

## Installation

The easiest way to install the package is through [PyPI](https://pypi.org/project/rasa-audiocodes).

```sh
pip install rasa-audiocodes
```

## Rasa Configuration

Add the following content to `credentials.yml`:

```yaml
rasa_audiocodes.AudiocodesInput:
  token: "CHOOSE_YOUR_TOKEN"
```

## Docker

If you're using Rasa on Docker, you can copy rasa_audiocodes and docker-compose.yml
to your application directory, and edit the volumes section to match your app directory.

If you already have a docker-compose file, just add this to the rasa volumes:

```yaml
      - ./rasa_audiocodes:/opt/venv/lib/python3.8/site-packages/rasa_audiocodes
```
## VoiceAI Connect Cloud Setup

The easiest way to start using VAIC is by visiting https://voiceaiconnect.audiocodes.io.

You can get a phone number, and route it to your bot.

Configuration is straight-forward. Click the + sign, then enter the name
of the bot, URL and the token.

You can now click Validate to verify that the bot is accessible and the
audiocodes channel is configured correctly.

![PNC Configuration](doc/pnc.png)

Click Next, then choose a country and a city to get a phone number.

After a minute, the number should be routed to your bot.

## VoiceAI Connect Configuration

If you maintain a VAIC instance, configure a provider with the following attributes:

```json
  {
    "name": "rasa",
    "type": "ac-bot-api",
    "botURL": "https://<RASA>/webhooks/audiocodes/webhook",
    "credentials": {
      "token": "CHOOSE_YOUR_TOKEN"
    }
  }
```


