PARSE_PHONE

The PARSE_PHONE function takes a phone number string and returns the phone number in the E.164 general format.

This function takes a string that represents a phone number and returns a properly formatted E.164 phone number string satisfying The Phone Variable Data Type requirements.

The region parameter is an optional two-digit country code that can be provided in case the phone string itself does not include a country code. If this parameter is omitted, the input phone number string must include the country code. If the input string contains a country code, the region parameter will be ignored.

If the input phone number string cannot be parsed into a valid phone number, the PARSE_PHONE function will throw an App Error.

{
  "airkitErrorType": "ApplicationError",
  "sourceProject": "cxr-undefined",
  "name": "ApplicationError",
  "identifier": "error.application.airscript.function.parse-phone",
  "metadata": {
    "message": "invalid-country-code",
    "url": "https://us.api.prod.airkit.com/internal/session-gateway/v1/connection/run",
    "statusText": "",
    "statusCode": 400
  },
  "httpStatus": 400
}

Declaration

PARSE_PHONE(phone_number_string, region) -> phone 

Parameters

phone_number_string (required, type: string)

The string to parse the phone from.

region (optional, type: string)

A two-character country code to be used phone_number_string

Return Values

phone (type: phone)

The resulting E.164 formatted phone number, or NULL if phone_number_string does not represent a valid phone number.

Examples

Parsing a string that is already in E.164 format will produce the same string.

PARSE_PHONE("+17167762323") -> "+17167762323"

Additional characters in the input string will be stripped. In the following example all spaces, as well as the trailing "ext. 5" portion of the string, will be removed leaving just the E.164 formatted phone number.

PARSE_PHONE("+1-716-776-2323 ext. 5") -> "+17167762323"

When a phone number cannot be parsed, the PARSE_PHONE function will return NULL.

PARSE_PHONE("not a phone number") -> ERROR

If a phone number has been collected from a user, it may not be in an E.164 format. The string "7167762323" is ambiguous without a country code as it may belong to more than one.

PARSE_PHONE("7167762323") -> ERROR

However, when the country code is known, it can be provided as a hint.

PARSE_PHONE("7167762323", "US") -> "+17167762323"
PARSE_PHONE("(716) 776-2323", "US") -> "+17167762323"

Note, however, that this is just a hint. If the input phone number does include a country code, that country code will take precedence as in this example with an Australian phone number.

PARSE_PHONE("+61 (02) 5550 1234", "US") -> "+61255501234"
PARSE_PHONE("(02) 5550 1234", "AU") -> "+61255501234"

Supported Country Codes

Country CodeCountry NamePhone Prefix

AF

Afghanistan

+93

AL

Albania

+355

DZ

Algeria

+213

AS

American Samoa

+1684

AD

Andorra

+376

AO

Angola

+244

AI

Anguilla

+1264

AQ

Antarctica

+672

AG

Antigua and Barbuda

+1268

AR

Argentina

+54

AM

Armenia

+374

AW

Aruba

+297

AU

Australia

+61

AT

Austria

+43

AZ

Azerbaijan

+994

BS

Bahamas

+1242

BH

Bahrain

+973

BD

Bangladesh

+880

BB

Barbados

+1246

BY

Belarus

+375

BE

Belgium

+32

BZ

Belize

+501

BJ

Benin

+229

BM

Bermuda

+1441

BT

Bhutan

+975

BO

Bolivia

+591

BA

Bosnia and Herzegovina

+387

BW

Botswana

+267

BR

Brazil

+55

IO

British Indian Ocean Territory

+246

VG

British Virgin Islands

+1284

BN

Brunei

+673

BG

Bulgaria

+359

BF

Burkina Faso

+226

MM

Myanmar

+95

BI

Burundi

+257

KH

Cambodia

+855

CM

Cameroon

+237

CA

Canada

+1

CV

Cape Verde

+238

KY

Cayman Islands

+1345

CF

Central African Republic

+236

TD

Chad

+235

CL

Chile

+56

CN

China

+86

CX

Christmas Island

+61

CC

Cocos Islands

+61

CO

Colombia

+57

KM

Comoros

+269

CG

Republic of the Congo

+242

CD

Democratic Republic of the Congo

+243

CK

Cook Islands

+682

CR

Costa Rica

+506

HR

Croatia

+385

CU

Cuba

+53

CW

Curacao

+599

CY

Cyprus

+357

CZ

Czech Republic

+420

DK

Denmark

+45

DJ

Djibouti

+253

DM

Dominica

+1767

DO

Dominican Republic

+1809

DO

Dominican Republic

+1829

DO

Dominican Republic

+1849

TL

East Timor

+670

EC

Ecuador

+593

EG

Egypt

+20

SV

El Salvador

+503

GQ

Equatorial Guinea

+240

ER

Eritrea

+291

EE

Estonia

+372

ET

Ethiopia

+251

FK

Falkland Islands

+500

FO

Faroe Islands

+298

FJ

Fiji

+679

FI

Finland

+358

FR

France

+33

PF

French Polynesia

+689

GA

Gabon

+241

GM

Gambia

+220

GE

Georgia

+995

DE

Germany

+49

GH

Ghana

+233

GI

Gibraltar

+350

GR

Greece

+30

GL

Greenland

+299

GD

Grenada

+1473

GU

Guam

+1671

GT

Guatemala

+502

GG

Guernsey

+441481

GN

Guinea

+224

GW

Guinea-Bissau

+245

GY

Guyana

+592

HT

Haiti

+509

HN

Honduras

+504

HK

Hong Kong

+852

HU

Hungary

+36

IS

Iceland

+354

IN

India

+91

ID

Indonesia

+62

IR

Iran

+98

IQ

Iraq

+964

IE

Ireland

+353

IM

Isle of Man

+441624

IL

Israel

+972

IT

Italy

+39

CI

Ivory Coast

+225

JM

Jamaica

+1876

JP

Japan

+81

JE

Jersey

+441534

JO

Jordan

+962

KZ

Kazakhstan

+7

KE

Kenya

+254

KI

Kiribati

+686

XK

Kosovo

+383

KW

Kuwait

+965

KG

Kyrgyzstan

+996

LA

Laos

+856

LV

Latvia

+371

LB

Lebanon

+961

LS

Lesotho

+266

LR

Liberia

+231

LY

Libya

+218

LI

Liechtenstein

+423

LT

Lithuania

+370

LU

Luxembourg

+352

MO

Macau

+853

MK

Macedonia

+389

MG

Madagascar

+261

MW

Malawi

+265

MY

Malaysia

+60

MV

Maldives

+960

ML

Mali

+223

MT

Malta

+356

MH

Marshall Islands

+692

MR

Mauritania

+222

MU

Mauritius

+230

YT

Mayotte

+262

MX

Mexico

+52

FM

Micronesia

+691

MD

Moldova

+373

MC

Monaco

+377

MN

Mongolia

+976

ME

Montenegro

+382

MS

Montserrat

+1664

MA

Morocco

+212

MZ

Mozambique

+258

NA

Namibia

+264

NR

Nauru

+674

NP

Nepal

+977

NL

Netherlands

+31

AN

Netherlands Antilles

+599

NC

New Caledonia

+687

NZ

New Zealand

+64

NI

Nicaragua

+505

NE

Niger

+227

NG

Nigeria

+234

NU

Niue

+683

MP

Northern Mariana Islands

+1670

KP

North Korea

+850

NO

Norway

+47

OM

Oman

+968

PK

Pakistan

+92

PW

Palau

+680

PS

Palestine

+970

PA

Panama

+507

PG

Papua New Guinea

+675

PY

Paraguay

+595

PE

Peru

+51

PH

Philippines

+63

PN

Pitcairn

+64

PL

Poland

+48

PT

Portugal

+351

PR

Puerto Rico

+1787

PR

Puerto Rico

+1939

QA

Qatar

+974

RE

Reunion

+262

RO

Romania

+40

RU

Russia

+7

RW

Rwanda

+250

BL

Saint Barthelemy

+590

WS

Samoa

+685

SM

San Marino

+378

ST

Sao Tome and Principe

+239

SA

Saudi Arabia

+966

SN

Senegal

+221

RS

Serbia

+381

SC

Seychelles

+248

SL

Sierra Leone

+232

SG

Singapore

+65

SX

Sint Maarten

+1721

SK

Slovakia

+421

SI

Slovenia

+386

SB

Solomon Islands

+677

SO

Somalia

+252

ZA

South Africa

+27

KR

South Korea

+82

SS

South Sudan

+211

ES

Spain

+34

LK

Sri Lanka

+94

SH

Saint Helena

+290

KN

Saint Kitts and Nevis

+1869

LC

Saint Lucia

+1758

MF

Saint Martin

+590

PM

Saint Pierre and Miquelon

+508

VC

Saint Vincent and the Grenadines

+1784

SD

Sudan

+249

SR

Suriname

+597

SJ

Svalbard and Jan Mayen

+47

SZ

Swaziland

+268

SE

Sweden

+46

CH

Switzerland

+41

SY

Syria

+963

TW

Taiwan

+886

TJ

Tajikistan

+992

TZ

Tanzania

+255

TH

Thailand

+66

TG

Togo

+228

TK

Tokelau

+690

TO

Tonga

+676

TT

Trinidad and Tobago

+1868

TN

Tunisia

+216

TR

Turkey

+90

TM

Turkmenistan

+993

TC

Turks and Caicos Islands

+1649

TV

Tuvalu

+688

AE

United Arab Emirates

+971

UG

Uganda

+256

GB

United Kingdom

+44

UA

Ukraine

+380

UY

Uruguay

+598

US

United States

+1

UZ

Uzbekistan

+998

VU

Vanuatu

+678

VA

Vatican

+379

VE

Venezuela

+58

VN

Vietnam

+84

VI

U.S. Virgin Islands

+1340

WF

Wallis and Futuna

+681

EH

Western Sahara

+212

YE

Yemen

+967

ZM

Zambia

+260

ZW

Zimbabwe

+263

Last updated