Sample code for 30+ languages & platforms
JavaScript Requires Chilkat v11.0.0+

Validate and format a phone number with Twilio Lookup

See more Twilio Examples

Use Basic Lookup v2 to check a national-format number and obtain its E.164 and national display formats. Supply the two-letter country code for a national number. The example requests only the basic fields.

Read the boolean valid field even when the HTTP request succeeds. When it is false, display any validation_errors that Twilio supplies. Numbering-plan validation does not establish reachability or control of a phone. To confirm control, send an SMS verification code.

Twilio documentation

Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.
JavaScript
var success = false;

//  Assumes Chilkat is unlocked. See Global Unlock Sample.
//  Load an API key for the Twilio account from private application configuration.
var http = new CkHttp();
http.RequireSslCertVerify = true;
http.BasicAuth = true;
http.Login = "YOUR_API_KEY_SID";
http.Password = "YOUR_API_KEY_SECRET";

//  The phone number is one URL path segment. Percent-encode spaces and any leading +.
var number = new CkStringBuilder();
number.Append("020 7946 0018");
var encoded = number.Encode("url_rfc3986","utf-8");
if (encoded !== true) {
    console.log("Could not encode the phone number.");
    return;
}

var url = new CkStringBuilder();
url.Append("https://lookups.twilio.com/v2/PhoneNumbers/");
url.Append(number.GetAsString());
url.Append("?CountryCode=GB");
var resp = new CkHttpResponse();
var reply = new CkJsonObject();

success = http.HttpNoBody("GET",url.GetAsString(),resp);
if (resp.StatusCode == 0) {
    console.log("No HTTP response from Twilio.");
    return;
}

var parsed = reply.Load(resp.BodyStr);
if ((success !== true) || (resp.StatusCode !== 200)) {
    console.log("Twilio returned HTTP " + resp.StatusCode);
    if ((parsed == true) && (reply.JsonTypeOf("code") == 2)) {
        console.log("Twilio error: " + reply.IntOf("code") + "  " + reply.StringOf("message"));
    }

    return;
}

if (parsed !== true) {
    console.log("Expected a JSON response from Twilio.");
    return;
}

if (reply.JsonTypeOf("valid") !== 5) {
    console.log("The lookup response is missing the validity flag.");
    return;
}

if (reply.BoolOf("valid") !== true) {
    console.log("The number is invalid for the specified country.");
    var i = 0;
    while ((i < reply.SizeOfArray("validation_errors"))) {
        reply.I = i;
        console.log(reply.StringOf("validation_errors[i]"));
        i = i+1;
    }

    return;
}

if (reply.JsonTypeOf("phone_number") !== 1) {
    console.log("The lookup response is missing the E.164 number.");
    return;
}

console.log("E.164: " + reply.StringOf("phone_number"));
console.log("National format: " + reply.StringOf("national_format"));