Skip to content

Latest commit

 

History

History
 
 

verify

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
assets
assets
 
 
functions
functions
 
 
tests
tests
 
 
.env
.env
 
 
README.md
README.md
 
 
package.json
package.json
 
 
phone-verification.gif
phone-verification.gif
 
 

README.md

Twilio Verify

These function show you how to send and check verification tokens for Twilio Verify. More details about how to work with Verify and Twilio functions can be found in this blog post.

phone-verification-gif

How to use the template

The best way to use the Function templates is through the Twilio CLI as described below. If you'd like to use the template without the Twilio CLI, check out our usage docs.

Pre-requisites

Environment variables

This project requires some environment variables to be set. To keep your tokens and secrets secure, make sure to not commit the .env file in git. When setting up the project with twilio serverless:init ... the Twilio CLI will create a .gitignore file that excludes .env from the version history.

In your .env file, set the following values:

Variable Meaning Required
ACCOUNT_SID Find in the console Yes
AUTH_TOKEN Find in the console Yes
VERIFY_SERVICE_SID Create one here Yes

Function Parameters

start-verify.js expects the following parameters:

Parameter Description Required
to Either an email or phone number in E.164 format Yes
channel 'sms', 'call', or 'email'. Default is 'sms' No
locale Localization language. See supported languages. Default is 'en' No

check-verify.js expects the following parameters:

Parameter Description Required
to Either an email or phone number in E.164 format Yes
verification_code Collected from user input Yes

Create a new project with the template

  1. Install the Twilio CLI
  2. Install the serverless toolkit
twilio plugins:install @twilio-labs/plugin-serverless
  1. Initiate a new project
twilio serverless:init verify-sample --template=verify && cd verify-sample
  1. Add your environment variables to .env:

Make sure variables are populated in your .env file. See Environment variables.

  1. Start the server :
npm start
  1. Open the web page at https://localhost:3000/index.html and enter your phone number to test

ℹ️ Check the developer console and terminal for any errors, make sure you've set your environment variables.

  1. [optional] Configure email verification

Follow the instructions in the docs to set up email verification.

Deploying

Deploy your functions and assets with either of the following commands. Note: you must run these commands from inside your project folder. More details in the docs.

With the Twilio CLI:

twilio serverless:deploy