Bot API
VoiceAI Connect Enterprise offers a generic Bot API designed for developers who want to build their own custom integration between VoiceAI Connect Enterprise and a proprietary bot service.
This is intended for cases where the bot does not use a framework already supported by VoiceAI Connect, such as Microsoft Azure Bot Service, Amazon Lex, or Google Dialogflow.
In some cases, this API can also be used to connect VoiceAI Connect Enterprise to a custom-developed middleware, which in turn bridges to a standard bot framework.
AudioCodes Bot API offers several advantages for developers:
-
Straightforward to implement
-
Simple authentication mechanism
-
Works smoothly across firewalls and HTTP proxies
-
Fully supports VoiceAI Connect Enterprise’s extensive feature set
Modes of operation
The Bot API supports two modes of operation, allowing flexibility depending on your architecture and use case:
-
Chat Mode: Based on HTTP request-response. This mode is suitable for simple, stateless implementations, such as bots hosted in AWS Lambda or similar environments.
-
Streaming Mode: Based on a bi-directional WebSocket. This mode is better suited for stateful bots and offers additional capabilities, such as:
-
Support for proactive messages from the bot
-
Audio streaming support
-
Chat mode also offers an optional WebSocket connection, in addition to the HTTP request-response messages, for proactive messaging.
Streaming mode is supported only by VoiceAI Connect Enterprise and from Version 3.24 or later.