Overview

You can use the Dialog API to integrate your Assistant with any custom channel or interface (voice, chat or multimodal). Any Voiceflow Project Type works with a Custom Channel deployment as it uses the Dialog API which is available across every project type.

The Dialog API integrates through a REST API with your Custom Channel.

Example Custom Channel Deployment

🚧

First steps

Before you start with the Dialog API, you need to create a project on your Voiceflow workspace.

Clone the starter pack
Download the API Examples repo found here to access a variety of prebuilt API examples, including Node.js, Python, Rust and HTML.

Authentication
We'll need to access the Project API key for the design we want to connect into our app. To obtain the API Key:

1. Open the Assistant project you are using
2. Select on the Integrations tab (shortcut: 3). Found on the left-hand menu.
3. Copy the Dialog API Key found in the Dialog API section.

Launch

Open up the API Examples pack in your favourite code editor.

👍

HTML and JQuery

1. Replace 'YOUR_API_KEY_HERE' in index.html with your API Key.
2. Open index.html on any browser to start your chat!

Example:

👍

Node.js

1. If you do not have node, install Node.js and npm from nodejs.org, or follow an equivalent guide.
2. In this folder, run npm install.
3. Replace 'YOUR_API_KEY_HERE' in index.js with your Dialog Manager API Key.
4. run npm start to start your chat!

Example:

$ npm start

> What is your name?: tyler
what can I do for you?
...
> Say something: send email
who is the recipient?
...
> Say something: [email protected]
what is the title of your email?
...
> Say something: How was your day?
sending the email for [email protected] called "How was your day?". Is that correct?
...
> Say something: yes
successfully sent the email for [email protected] called "How was your day?"
The end! Start me again with `npm start`

Video Walkthrough

Dialog Manager API Examples

github.com

GitHub - voiceflow/api-examples: examples implementing the voiceflow dialog manager API