Skip to content Skip to navigation Skip to topbar

On this page

Normalize telephone numbers

Twilio's APIs consistently use the E.164 standard for phone numbers. This format is fine within your code, but it presents a couple of user-facing issues:

E.164 is difficult to understand when presented as plain text, such as in an SMS
When read aloud by a Twilio Say verb or Say Widget, numbers such as +15095550100 will be read literally as a large number, instead of digit-by-digit. (ex. "Plus fifteen billion, ninety-five million, five hundred fifty thousand, one hundred")

Fortunately, Twilio Lookup enables you to convert a given E.164 phone number into the national format used by that country, which Twilio will read aloud as one would normally say it in their region.

To get started, use the following instructions to create a Function to host your code.

Create and host a Function

In order to run any of the following examples, you will first need to create a Function into which you can paste the example code. You can create a Function using the Twilio Console or the Serverless Toolkit as explained below:

ConsoleServerless Toolkit

If you prefer a UI-driven approach, creating and deploying a Function can be done entirely using the Twilio Console and the following steps:

Log in to the Twilio Console and navigate to the Functions tab. If you need an account, you can sign up for a free Twilio account here!
Functions are contained within Services. Create a Service by clicking the Create Service button and providing a name such as test-function.
Once you've been redirected to the new Service, click the Add + button and select Add Function from the dropdown.
This will create a new Protected Function for you with the option to rename it. The name of the file will be path it is accessed from.
Copy any one of the example code snippets from this page that you want to experiment with, and paste the code into your newly created Function. You can quickly switch examples by using the dropdown menu of the code rail.
Click Save to save your Function's contents.
Click Deploy All to build and deploy the Function. After a short delay, your Function will be accessible from: https://<service-name>-<random-characters>-<optional-domain-suffix>.twil.io/<function-path>
For example: test-function-3548.twil.io/hello-world.

The Serverless Toolkit enables you with local development, project deployment, and other functionality via the Twilio CLI. To get up and running with these examples using Serverless Toolkit, follow this process:

From the CLI, run twilio serverless:init <your-service-name> --empty to bootstrap your local environment.
Navigate into your new project directory using cd <your-service-name>
In the /functions directory, create a new JavaScript file that is named respective to the purpose of the Function. For example, sms-reply.protected.js for a Protected Function intended to handle incoming SMS.
Populate the file using the code example of your choice and save. Note A Function can only export a single handler. You will want to create separate files if you want to run and/or deploy multiple examples at once.

Once your Function(s) code is written and saved, you can test it either by running it locally (and optionally tunneling requests to it via a tool like ngrok), or by deploying the Function and executing against the deployed url(s).

Run your Function in local development

Run twilio serverless:start from your CLI to start the project locally. The Function(s) in your project will be accessible from http://localhost:3000/sms-reply

If you want to test a Function as a Twilio webhook, run: twilio phone-numbers:update <your Twilio phone number> --sms-url "http://localhost:3000/sms-reply"
This will automatically generate an ngrok tunnel from Twilio to your locally running Function, so you can start sending texts to it. You can apply the same process but with the voice-url flag instead if you want to test with Twilio Voice.
If your code does not connect to Twilio Voice/Messages as a webhook, you can start your dev server and start an ngrok tunnel in the same command with the ngrok flag. For example: twilio serverless:start --ngrok=""

Deploy your Function

To deploy your Function and have access to live url(s), run twilio serverless:deploy from your CLI. This will deploy your Function(s) to Twilio under a development environment by default, where they can be accessed from:

https://<service-name>-<random-characters>-dev.twil.io/<function-path>

For example: https://incoming-sms-examples-3421-dev.twil.io/sms-reply

Your Function is now ready to be invoked by HTTP requests, set as the webhook of a Twilio phone number, invoked by a Twilio Studio Run Function Widget, and more!

Respond to a call directly with TwiML

The following Function is one which will tell the user their phone number, in the format that they would expect in normal conversation. This will also work for international phone numbers!

To verify this for yourself, paste the code into the Function that you just made, and set it as the A Call Comes In webhook handler for the Twilio phone number you wish to test. The following instructions will show you how to do so.

Convert a number to its national format

1exports.handler = async (context, event, callback) => {
2  // The pre-initialized Twilio client is available from the `context` object
3  const client = context.getTwilioClient();
4  // Create a new voice response object
5  const twiml = new Twilio.twiml.VoiceResponse();
6
7  // The From value is provided by Twilio to this webhook Function, and contains the caller's
8  // phone number in E.164 format, ex. '+15095550100'
9  const from = event.From;
10
11  // Call Twilio Lookup to get information about the number, including its national format
12  const result = await client.lookups.phoneNumbers(from).fetch();
13
14  // Read back the caller's phone number in the way it would normally spoken, not as a
15  // massive integer!
16  twiml.say(`Your phone number is ${result.nationalFormat}`);
17  return callback(null, twiml);
18};

Set a Function as a webhook

In order for your Function to react to incoming SMS and/or voice calls, it must be set as a webhook for your Twilio number. There are a variety of methods to set a Function as a webhook, as detailed below:

Twilio ConsoleTwilio CLITwilio SDKs

You can use the Twilio Console UI as a straightforward way of connecting your Function as a webhook:

Log in to the Twilio Console's Phone Numbers page.
Click on the phone number you'd like to have connected to your Function.
If you want the Function to respond to incoming SMS, find the A Message Comes In option under Messaging. If you want the Function to respond to Voice, find the A Call Comes In option under Voice & Fax.
Select Function from the A Message Comes In or A Call Comes In dropdown.
Select the Service that you are using, then the Environment (this will default to ui unless you have created custom domains ), and finally Function Path of your Function from the respective dropdown menus.

Alternatively, you could select Webhook instead of Function, and directly paste in the full URL of the Function.

Click the Save button.

You can also use the Twilio CLI to assign the Function as the webhook of you phone number. You will need a few prerequisites:

Twilio CLI installed and executable from your terminal.
Either the E.164 formatted value of your Twilio phone number (+1234567890), or its SID (PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX).
The full URL of your Function (https://test-1337.twil.io/my-test-function)

Once you have the CLI installed and the necessary information, run the following to connect the Function to respond to incoming SMS:

1twilio phone-numbers:update +1234567890 \
2  --sms-url https://test-1337.twil.io/my-test-function

If you prefer to have the Function respond to incoming calls instead, run:

1twilio phone-numbers:update +1234567890 \
2  --voice-url https://test-1337.twil.io/my-test-function

You may also use the SID of your Twilio phone number instead of the E.164 formatted phone number:

1twilio phone-numbers:update PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \
2  --sms-url https://test-1337.twil.io/my-test-function

You can also use any of the available Twilio SDKs to assign the Function as the webhook of you phone number. You will need a few prerequisites:

A local development environment for your language of choice and the associated Twilio SDK installed.
The SID (PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX) of your Twilio phone number.
The full URL of your Function (https://test-1337.twil.io/my-test-function).

In JavaScript for example, you could execute the following code to assign the SMS webhook of your Twilio phone number. The same logic would apply for assigning to a voice webhook, except that the modified property instead would be voiceUrl:

1// Download the helper library from https://www.twilio.com/docs/node/install
2// Find your Account SID and Auth Token at twilio.com/console
3// and set the environment variables. See http://twil.io/secure
4const accountSid = process.env.TWILIO_ACCOUNT_SID;
5const authToken = process.env.TWILIO_AUTH_TOKEN;
6const client = require('twilio')(accountSid, authToken);
7
8client
9  .incomingPhoneNumbers('PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
10  .update({ smsUrl: 'https://test-1337.twil.io/my-test-function' })
11  .then((phoneNumber) => console.log(phoneNumber.smsUrl));
12

Read out phone numbers in a Studio Flow

This functionality also lends itself well to Studio Flows, where you may share a phone number as part of your IVR. The Say widget doesn't natively read E.164 formatted numbers in the national format, but clever use of the Run Function widget with the following sample code will enable this.

Create a Studio Flow

First, create a new Studio Flow. We suggest following the Create Your Flow directions from a Studio tutorial.

Connect and configure your widgets

Once you have created a Flow, drag a Run Function and a Say/Play widget onto the Studio canvas. Connect the Incoming Call trigger to the Run Function widget by dragging from the trigger to on top of the widget, and similarly connect the Run Function widget's "Success" condition to the Say/Play widget.

With the widgets connected, the next step is to configure them.

Click on the Run Function widget, which should cause the Widget Library to show the configuration options for the widget. Name the widget as you like, and use the drop-down menus to select the Service and path of the Function that you created previously. To wrap up the configuration, click Add under Function Parameters, set the "Key" to From, and "Value" to {{contact.channel.address}}. This will cause the phone number of the incoming caller to be passed to the Function as a parameter called From.

Your configuration and connections should look similar to this:

Studio Flow showing configuration for a Run Function widget that calls a phone number normalization Function.

Following a similar process, configure the Say/Play widget with your desired name, and paste the following into the "Text to Say" field:

Hi! Your phone number is {{widgets.<widget-name>.parsed.normalizedPhoneNumber}}.

Replace <widget-name> with the name of your Run Function widget. This means the Say/Play widget will access the results of the Run Function widget, retrieve a value named normalizedPhoneNumber, and will attempt to read it back to the caller. You can read here to get more context around the parsed property.

Click Publish to publish your Studio Flow.

Update your Function's code

With the Studio Flow published and expecting new behavior from your Function, it will need some slight modifications.

Edit or replace the body of your Function with the following sample code. Note that it is returning the normalizedPhoneNumber that is expected by the Say/Play widget.

With your code changes complete, save and deploy your Function.

Provides readable phone numbers to Studio Flows

1exports.handler = async (context, event, callback) => {
2  // The pre-initialized Twilio client is available from the `context` object
3  const client = context.getTwilioClient();
4  // The From value should be provided as a parameter by the Run Function widget, and contains
5  // the caller's phone number in E.164 format, ex. '+15095550100'
6  const from = event.From;
7
8  // Call Twilio Lookup to get information about the number, including its national format
9  const result = await client.lookups.phoneNumbers(from).fetch();
10
11  // Return the caller's phone number in the way it would normally spoken
12  // Access this in a Studio Flow with `{{widgets.<widget-name>.parsed.normalizedPhoneNumber}}`
13  return callback(null, {
14    normalizedPhoneNumber: result.nationalFormat,
15  });
16};

Connect and test your Flow

To test your Flow, connect your Twilio phone number to the Studio Flow.

With your Twilio phone number connected to the Studio Flow, you can call your Twilio phone number and have a synthesized voice read out the number you are calling from in a human-friendly manner.