AudioCodes Voice.AI Gateway Bot API Reference Guide
Reference Guide
AudioCodes Intuitive Human Communications for Chatbot Services
Voice.AI Gateway Bot
API
Version 1.6
Notice
Voice.AI Gateway | API Reference Guide
Notice
Information contained in this document is believed to be accurate and reliable at the time
of printing. However, due to ongoing product improvements and revisions, AudioCodes
cannot guarantee accuracy of printed material after the Date Published nor can it accept
responsibility for errors or omissions. Updates to this document can be downloaded from
https://www.audiocodes.com/library/technical-documents.
This document is subject to change without notice.
Date Published: June-09-2020
WEEE EU Directive
Pursuant to the WEEE EU Directive, electronic and electrical waste must not be disposed of
with unsorted waste. Please contact your local recycling authority for disposal of this product.
Customer Support
Customer technical support and services are provided by AudioCodes or by an authorized
AudioCodes Service Partner. For more information on how to buy technical support for
AudioCodes products and for contact information, please visit our website at
https://www.audiocodes.com/services-support/maintenance-and-support.
Documentation Feedback
AudioCodes continually strives to produce high quality documentation. If you have any
comments (suggestions or errors) regarding this document, please fill out the Documentation
Feedback form on our website at https://online.audiocodes.com/documentation-feedback.
Stay in the Loop with AudioCodes
Notes and Warnings
OPEN SOURCE SOFTWARE. Portions of the software may be open source software
and may be governed by and distributed under open source licenses, such as the terms
of the GNU General Public License (GPL), the terms of the Lesser General Public
License (LGPL), BSD and LDAP, which terms are located at
https://www.audiocodes.com/services-support/open-source/ and all are incorporated
herein by reference. If any open source software is provided in object code, and its
- ii -
Notice
Voice.AI Gateway | API Reference Guide
accompanying license requires that it be provided in source code as well, Buyer may
receive such source code by contacting AudioCodes, by following the instructions
available on AudioCodes website.
Related Documentation
Document Name
Voice.AI Gateway Product Description
Voice.AI Gateway Integration Guide
Voice.AI Gateway One-Click Dialogflow Integration Guide
Document Revision Record
LTRT Description
30940 Initial document release.
30941 Updated to Ver. 1.6 (health check)
- iii -
Content
Voice.AI Gateway | API Reference Guide
Table of Contents
1 Introduction 1
Purpose 1
Targeted Audience 1
2 Overview 2
3 Conversation Flow 3
4 API 5
Before You Begin 5
Creation of a Conversation 5
Sending and Receiving Activities 7
Conversation Refresh 10
Ending a Conversation 11
Health Check 12
5 Security 13
TLS Usage 13
Voice.AI Gateway Authentication 13
- iv -
CHAPTER1 Introduction
1 Introduction
AudioCodes Voice.AI Gateway enhances chatbot functionality by allowing human
communication with chatbots through voice (voicebot), offering an audio- centric user
experience. Integrating the Voice.AI Gateway into your chatbot environment provides you
with a single-vendor solution, assisting you in migrating your text-based chatbot experience
into a voice-based chatbot.
AudioCodes Voice.AI Gateway provides a generic bot API that can be used for connecting it to
any bot service that doesn't use the standard bot frameworks (such as Microsoft Azure,
Amazon Lex, and Google Dialogflow). This Customer-proprietary bot service could also employ
middleware that proxies between it and the Voice.AI Gateway. In such a scenario, it's
preferable that the Voice.AI Gateway connects directly to your framework or middleware.
AudioCodes bot API offers the following benefits:
■ Easy to implement
Voice.AI Gateway | API Reference Guide
■ Simple authentication scheme
■ Traverses firewalls and HTTP proxies
■ Enables the bot to use the Voice.AI Gateway's wide range of features
Prior to reading this document, it's recommended that you read the Voice.AI Gateway
Product Description to familiarize yourself with AudioCodes Voice.AI Gateway
architecture and solution.
Purpose
This guide provides AudioCodes' APIs for connecting your bot service (proprietary bot or
middleware) to AudioCodes Voice.AI Gateway.
Targeted Audience
This guide is intended for developers of bot frameworks and middleware.
- 1 -
CHAPTER2 Overview
2 Overview
■ Roles in the bot API:
● Client: Voice.AI Gateway
● Server: Your bot service
■ You should implement the server-side of the API so that the Voice.AI Gateway can connect
to it.
■ The API uses HTTP. All requests by the Voice.AI Gateway are sent to the bot service.
■ The API only conveys textual messages (not voice), as the Voice.AI Gateway uses speech-
to-Text (STT) and Text-to-Speech (TTS) engines.
Voice.AI Gateway | API Reference Guide
- 2 -
Loading...