@cxco/twilio

Introduction

DigitalCX's ready-to-go integration between DigitalCX and Twilio's voice platform. This project requires you to set up a project on Twilio's platform. This project provides you with the web hook logic that you can expose on top of your pre-existing Express.js server.

Pre-requirements

Twilio voice Pre-requirements To start using the Twilio voice integration (TVI) we have some requirements:

This module gets its content from a database (DigitalCX), so before you can proceed with anything, you’ll need to have a database created and published. Only then you can get the following information to connect to the right database:

• Customer Key
• Project Key
• Api Key
• Culture

In order to connect the TVI module to Twilio, you need to set up a project on Twilio. You can read all about it in their documentation.

To use the TVI node module you need to have a pre-existing Express server. This module is used as a middleware inside your Express server to make the communication between DigitalCX database and Twilio possible. The module provides webhook logic that you can expose on top of your Express server.

Getting Started

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. This module was developed using Node.js v8.12.0.

Installation is done using the npm install command:

npm i @cxco/twilio

This module has been set up using Twilio's Node.js Getting Started guide.

Using the package

@cxco/twilio is a Express.js middleware function. Use it as such, passing in the necessary configuration options.

const express = require('express')
const twilio = require('@cxco/twilio')

const app = express()

app.use('/twilio', twilio({
    dcx: {
        customerKey: 'customer key',
        projectKey: 'project key',
        culture: 'culture',
        apiKey: 'api key',
        environmentUrl: 'https://dev.digitalcx.com/cxcompany/projects/devdemos',
        onLoadEvent: 'speech__onLoad'
    },
    transcribe: () => console.log('your transcribe implementation'),
    messages: {
        errorMessages: {
            dcxNoResponseMessage: 'No response from DigitalCX',
            noInputFromUserMessage: 'No input from user',
            applicationErrorMessage: 'Something went wrong! Please contact support'
        }
    }

}))

app.listen(3000)

Configuration

The DigitalCX Twilio integration offers a number of configuration options, some of them required and some of them optional. All configuration options need to be passed along wrapped in a single object and presented as the first parameter:

Parameter Name	Type	Description	Required	Example
dcx	object	An object containing the information required to connect and authenticate your application with and to the DigitalCX engine.	yes	{"customerKey":"ckey", "projectKey":"pkey", "culture":"en","apiKey":"api key","environment":"production","onLoadEvent":"dcx-twilio-onload"}
dialogOptionPrompts	array	An array of string values that will be (randomly) cycled through when a dialog or transactional dialog contains dialog options or quick replies.	no	["We have several pre defined options available to you:", "Please choose one of the following replies:"]
transcribe	function	A function that'll be called when receiving a recording from Twilio. The function should accept an audio file as it's first parameter and is responsible for returning a string representing the transcription.	yes	audio => 'Transcribed'
errorMessages	object	An object containing the three possible error messages that can originate within the dcx-twilio library. These error messages will be directly passed over to the caller whenever one such error occurs.	yes	{ "dcxNoResponseMessage":"msg", "noInputFromUserMessage":"msg", "applicationErrorMessage":"msg" }

Features

• Hooks into any Express.js server as Express middleware.
• Offers full support for Q&A's, events, dialogs and transactional dialogs.
• Each instance can be configured to integrate with a single customer-project-culture combination.
• Multiple instances can easily be created

Build and Test

To run the test suite, first install the dependencies, then run npm test:

npm i
npm test