Flex SDK Demo

Why

This is a sample app to demonstrate the use of Flex SDK to build standalone apps with the framework of your choice. It uses APIs and EventListeners to manage the user session and listen for incoming events.

Some prerequisites to run this application are as follows:

• You should have a Twilio Flex account

• You have a verified Phone number for your Flex instance

• Your Studio Flow is correctly configured with your Flex instance

• Your Flex account is correctly configured with Enhanced SSO or you have a service capable of provisioning a user authentication token

• Flex SDK Demo

  • Why
  • SSO setup
  • Prerequisites
  • Getting Started
  • Installation
  • Usage
    • Running the application locally
    • Usage

SSO setup

• Go to SSO settings page of your Twilio Flex account - you will be able to see ACS url and entity ID for the OAuth 2.0 connection associated with your account
• Follow this doc for the SSO setup and refer to the values mentioned under Enhanced SSO configuration. You will find those values in the above step in Console.
• In order to run this sample app locally, add http://localhost:5173/agentDesktop to "Trusted URLs" in SSO Configuration

Prerequisites

This project requires NodeJS (version 14 or later) and NPM (version 8 or later). Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
v8.1.0
v16.13.0

Getting Started

In order to run the application follow this guideline

Installation

BEFORE YOU INSTALL: please read the prerequisites

Start with cloning this repo on your local machine:

$ git clone https://github.com/twilio-samples/flex-sdk-demo.git
$ cd flex-sdk-demo

To install and set up the library, run:

$ npm install

Usage

Running the application locally

$ npm run dev

Open your browser at localhost:5173

Usage

One of the most common use cases that we try out in the application is triggering an incoming call, accepting it and after the call is complete, end it, and complete the task.

• You can trigger an incoming call using the twilio-dev-phone
• Accept the call
• Once done end the call and complete the task