phone
v0.5.8

Phone (phone v0.5.8)

Phone is a real telephone number parser, that will help you get useful information from numbers.

How to use

Very simple to use:

iex> Phone.parse("555132345678")
{:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}}

Summary

Functions

parse(number)

Parses a string or integer and returns a map with information about that number.

parse(number, atom)

Same as parse/1 but the number doesn't have the international code, instead you specify country as an atom with two-letters code.

parse!(number)

Same as parse/1, except it raises on error.

parse!(number, atom)

Same as parse/2, except it raises on error.

valid?(number)

Returns true if the number can be parsed, otherwise returns false.

Functions

Link to this function

parse(number)

@spec parse(String.t() | pos_integer()) :: {:ok, map()} | {:error, String.t()}

Parses a string or integer and returns a map with information about that number.

  iex> Phone.parse("555132345678")
  {:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}}

  iex> Phone.parse("+55(51)3234-5678")
  {:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}}

  iex> Phone.parse("55 51 3234-5678")
  {:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}}

  iex> Phone.parse(555132345678)
  {:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}}
Link to this function

parse(number, atom)

@spec parse(String.t() | pos_integer(), atom()) :: {:ok, map()} | {:error, String.t()}

Same as parse/1 but the number doesn't have the international code, instead you specify country as an atom with two-letters code.

For NANP countries you can use the atom :nanp or two-letter codes for any country in NANP.

For United Kingdom is possible to use the more known acronym :uk or the official two-letter code :gb.

iex> Phone.parse("5132345678", :br)
{:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}}

iex> Phone.parse("(51)3234-5678", :br)
{:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}}

iex> Phone.parse("51 3234-5678", :br)
{:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}}

iex> Phone.parse(5132345678, :br)
{:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}}
Link to this function

parse!(number)

@spec parse!(String.t() | pos_integer()) :: map()

Same as parse/1, except it raises on error.

iex> Phone.parse!("555132345678")
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}

iex> Phone.parse!("+55(51)3234-5678")
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}

iex> Phone.parse!("55 51 3234-5678")
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}

iex> Phone.parse!(555132345678)
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}
Link to this function

parse!(number, atom)

@spec parse!(String.t() | pos_integer(), atom()) :: map()

Same as parse/2, except it raises on error.

iex> Phone.parse!("5132345678", :br)
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}

iex> Phone.parse!("(51)3234-5678", :br)
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}

iex> Phone.parse!("51 3234-5678", :br)
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}

iex> Phone.parse!(5132345678, :br)
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "32345678", area_abbreviation: "RS", area_type: "state", area_name: "Rio Grande do Sul"}
Link to this function

valid?(number)

@spec valid?(String.t() | pos_integer()) :: boolean()

Returns true if the number can be parsed, otherwise returns false.

iex> Phone.valid?("555132345678")
true

iex> Phone.valid?("+55(51)3234-5678")
true

iex> Phone.valid?("55 51 3234-5678")
true

iex> Phone.valid?(555132345678)
true