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 phone number string satisfying 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)

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 Code

Country Name

Phone Prefix

Afghanistan

+93

Albania

+355

Algeria

+213

American Samoa

+1684

Andorra

+376

Angola

+244

Anguilla

+1264

Antarctica

+672

Antigua and Barbuda

+1268

Argentina

+54

Armenia

+374

Aruba

+297

Australia

+61

Austria

+43

Azerbaijan

+994

Bahamas

+1242

Bahrain

+973

Bangladesh

+880

Barbados

+1246

Belarus

+375

Belgium

+32

Belize

+501

Benin

+229

Bermuda

+1441

Bhutan

+975

Bolivia

+591

Bosnia and Herzegovina

+387

Botswana

+267

Brazil

+55

British Indian Ocean Territory

+246

British Virgin Islands

+1284

Brunei

+673

Bulgaria

+359

Burkina Faso

+226

Myanmar

+95

Burundi

+257

Cambodia

+855

Cameroon

+237

Canada

Cape Verde

+238

Cayman Islands

+1345

Central African Republic

+236

Chad

+235

Chile

+56

China

+86

Christmas Island

+61

Cocos Islands

+61

Colombia

+57

Comoros

+269

Republic of the Congo

+242

Democratic Republic of the Congo

+243

Cook Islands

+682

Costa Rica

+506

Croatia

+385

Cuba

+53

Curacao

+599

Cyprus

+357

Czech Republic

+420

Denmark

+45

Djibouti

+253

Dominica

+1767

Dominican Republic

+1809

Dominican Republic

+1829

Dominican Republic

+1849

East Timor

+670

Ecuador

+593

Egypt

+20

El Salvador

+503

Equatorial Guinea

+240

Eritrea

+291

Estonia

+372

Ethiopia

+251

Falkland Islands

+500

Faroe Islands

+298

Fiji

+679

Finland

+358

France

+33

French Polynesia

+689

Gabon

+241

Gambia

+220

Georgia

+995

Germany

+49

Ghana

+233

Gibraltar

+350

Greece

+30

Greenland

+299

Grenada

+1473

Guam

+1671

Guatemala

+502

Guernsey

+441481

Guinea

+224

Guinea-Bissau

+245

Guyana

+592

Haiti

+509

Honduras

+504

Hong Kong

+852

Hungary

+36

Iceland

+354

India

+91

Indonesia

+62

Iran

+98

Iraq

+964

Ireland

+353

Isle of Man

+441624

Israel

+972

Italy

+39

Ivory Coast

+225

Jamaica

+1876

Japan

+81

Jersey

+441534

Jordan

+962

Kazakhstan

Kenya

+254

Kiribati

+686

Kosovo

+383

Kuwait

+965

Kyrgyzstan

+996

Laos

+856

Latvia

+371

Lebanon

+961

Lesotho

+266

Liberia

+231

Libya

+218

Liechtenstein

+423

Lithuania

+370

Luxembourg

+352

Macau

+853

Macedonia

+389

Madagascar

+261

Malawi

+265

Malaysia

+60

Maldives

+960

Mali

+223

Malta

+356

Marshall Islands

+692

Mauritania

+222

Mauritius

+230

Mayotte

+262

Mexico

+52

Micronesia

+691

Moldova

+373

Monaco

+377

Mongolia

+976

Montenegro

+382

Montserrat

+1664

Morocco

+212

Mozambique

+258

Namibia

+264

Nauru

+674

Nepal

+977

Netherlands

+31

Netherlands Antilles

+599

New Caledonia

+687

New Zealand

+64

Nicaragua

+505

Niger

+227

Nigeria

+234

Niue

+683

Northern Mariana Islands

+1670

North Korea

+850

Norway

+47

Oman

+968

Pakistan

+92

Palau

+680

Palestine

+970

Panama

+507

Papua New Guinea

+675

Paraguay

+595

Peru

+51

Philippines

+63

Pitcairn

+64

Poland

+48

Portugal

+351

Puerto Rico

+1787

Puerto Rico

+1939

Qatar

+974

Reunion

+262

Romania

+40

Russia

Rwanda

+250

Saint Barthelemy

+590

Samoa

+685

San Marino

+378

Sao Tome and Principe

+239

Saudi Arabia

+966

Senegal

+221

Serbia

+381

Seychelles

+248

Sierra Leone

+232

Singapore

+65

Sint Maarten

+1721

Slovakia

+421

Slovenia

+386

Solomon Islands

+677

Somalia

+252

South Africa

+27

South Korea

+82

South Sudan

+211

Spain

+34

Sri Lanka

+94

Saint Helena

+290

Saint Kitts and Nevis

+1869

Saint Lucia

+1758

Saint Martin

+590

Saint Pierre and Miquelon

+508

Saint Vincent and the Grenadines

+1784

Sudan

+249

Suriname

+597

Svalbard and Jan Mayen

+47

Swaziland

+268

Sweden

+46

Switzerland

+41

Syria

+963

Taiwan

+886

Tajikistan

+992

Tanzania

+255

Thailand

+66

Togo

+228

Tokelau

+690

Tonga

+676

Trinidad and Tobago

+1868

Tunisia

+216

Turkey

+90

Turkmenistan

+993

Turks and Caicos Islands

+1649

Tuvalu

+688

United Arab Emirates

+971

Uganda

+256

United Kingdom

+44

Ukraine

+380

Uruguay

+598

United States

Uzbekistan

+998

Vanuatu

+678

Vatican

+379

Venezuela

+58

Vietnam

+84

U.S. Virgin Islands

+1340

Wallis and Futuna

+681

Western Sahara

+212

Yemen

+967

Zambia

+260

Zimbabwe

+263

PreviousISPHONE NextEmail Functions

Last updated 1 year ago

Was this helpful?

{ "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 }