Twilio Flex Plugin for Verify

Setup

Requirements:

1. Node version 10.19.0 or later (check version in your terminal with node -v).
2. A Twilio account.
3. A Flex project. Create a Flex project in the console.
4. A Verify service. Create a new Verify service in the console.
5. The Twilio CLI. Install the CLI for your operating system and login with your Flex account credentials using twilio login.
6. The Twilio serverless plugin. Install from the command line with twilio plugins:install @twilio-labs/plugin-serverless. More details in the docs.
7. The Twilio Flex plugin. Install from the command line with twilio plugins:install @twilio-labs/plugin-flex. More details on GitHub.

After cloning this repository, install dependencies with npm:

npm install

Deploy verification serverless functions

Copy the serverless config example and fill in the ACCOUNT_SID, AUTH_TOKEN, and VERIFY_SERVICE_SID:

cp serverless/.env.serverless.example serverless/.env

Deploy the functions with the Twilio CLI:

twilio serverless:deploy

Save the function URLs that display with the deployment details

Copy the.env.example in the project root to .env:

# in the project root
cp .env.example .env

Update the REACT_APP_SERVICE_BASE_URL to be your new function url.

REACT_APP_SERVICE_BASE_URL="http://verify-plugin-1234-dev.twil.io"

Run the plugin locally

twilio flex:plugins:start

Deploy the plugin

twilio flex:plugins:deploy

Known issues

• "INFO" tab marker shows (even though it's empty) when the user is not verified

Todo

• fix "INFO" tab marker
• automatic authentication before the call is accepted - use DTMF to input code (WIP different plugin)
• add resend button
• add tests
• use material-ui for form input and errors
• maybe: add authentication to Twilio functions
• maybe: add ability for agent to cancel a verification
• maybe: rearchitect with custom actions?

Code of Conduct

This project adheres to the Twilio Labs Code of Conduct.

Contributing

This project welcomes contributions. Please check out our contributing guide to learn more on how to get started.

License

MIT © Twilio Inc.