SMS Verification for Android - Server for Node.js

This sample project demonstrates how to use Twilio's Verify to verify Android application user's phone numbers. This application supports the SMS Retriever API from Google.

You'll also need to have an Android application that you configure to use these URLs to verify phone numbers. Google has a guide for Requesting SMS Verification in an Android app, or you can go straight to their open source example Android app in the identity-samples GitHub repository.

Configure the sample application

To run the application, you'll need to gather your Twilio account credentials and configure them in a file named .env. To create this file from an example template, do the following in your Terminal.

cp .env.example .env

Open .env in your favorite text editor and configure the following values. You will need all of these values before you continue.

Config Value	Description
TWILIO_ACCOUNT_SID	Your primary Twilio account identifier - find this in the console here.
TWILIO_API_KEY	Used to authenticate - generate one here.
TWILIO_API_SECRET	Used to authenticate - just like the above, you'll get one here.
APP_HASH	Matches the Android application to the SMS message - See Google's documentation on how to Compute your app's hash string.
CLIENT_SECRET	Matches the Android application to the server - you can set this in the strings.xml file in your Android application. It must match the server's config value. You can also override it in the Settings menu of the app.
VERIFICATION_SERVICE_SID	This project uses Twilio Verify to send verification codes and to check their status - create a service here.
COUNTRY_CODE	Twilio Verify requires E.164 formatted phone numbers. This project uses Twilio Lookup to convert phone numbers into the expected format, based on the country for the phone number (Example: US). Find your ISO country codes here

A Note on API Keys

When you generate an API key pair at the URLs above, your API Secret will only be shown once - make sure to save this information in a secure location, or possibly your ~/.bash_profile.

Run the sample application

Now that the application is configured, we need to install our dependencies from npm.

npm install

Now we should be all set! Run the application using the npm start command.

npm start

Your application should now be running at http://localhost:3000/.

Check your config values, and then make sure everything looks good.

Running the server with ngrok

Your phone won't be able to access localhost directly. You'll need to create a publicly accessible URL using a tool like ngrok to send HTTP/HTTPS traffic to a server running on your localhost.

You can also deploy this application to a server, or to a cloud provider such as Google App Engine.

ngrok http 3000

Setting the server for the Android application

You'll need to update the Android application with the URLs from ngrok, if you are running locally. If you've deployed this solution to a server, you can use those URLs.

License

MIT