Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Endpoint ID:6010
Method:
Status
colourGreen
titleGET
URL:

 /services/phonenumber/format/{phoneNumber}/{phoneNumberFormat=E164}?countryCode={countryCode}&countryCodeFormat={countryCodeFormat}

 phoneNumber

Phone number to be formatted.

Valid examples

  • +4529254029
  • 29254029 (valid only if country code is specified)
  phoneNumberFormat

 Desired format, if not specified default is set to E164.

Valid format options are

  • E164 - Default value. ( Its a general format for international telephone numbers prefixed with the character + (plus sign) and country dial code. Example :  +4529254029 )
  • National - ( Its a general format numbers without character + (plus sign) and country dial code. Example: 29254029 )
  • International - ( Its is like E164 format with spaces between numbers. Example: +45 29 25 40 29 )
  • RFC3966 - (The "tel" URI describes resources identified by telephone numbers. Example : tel:+45-29-25-40-29)
  • Custom - (Used for legacy phone number beautifier implementation  Example : 4529254029)
 countryCode

Optional value to identify country of phoneNumber.

 countryCodeFormat 

Optional value to identify countryCode format.

Valid values are

  • ISO2 ( ISO 3166-1 alpha-2 – two letter country codes )
  • ISO3 ( ISO 3166-1 alpha-3 – three letter country codes )
  • ISON ( ISO 3166-1 numeric – three digit country codes )
  • Internet ( Top level domain names on web )
  • Custom ( Used for legacy phone number beautifier implementation )
Request body:None

Span
stylewhite-space:pre

Response body:

JSON data with information about the valid phone number 

 

Code Block
titleExample – Format +4529254029 as Intennational
{
	"phoneNumber":+45 29 25 40 29
}

   

Status codes:200

Phone number is formatted successfully.

 400

The following sub codes may be returned:

 

400.1Invalid Phone number.
400.2Phone number must be in international E164 format if country code is not specified.
400.3Invalid Country code format.
400.4 Invalid phone number format. 
 404

No matching country code found for country code format. 

...