Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Formatting
Excerpt

Validate phone number and return valid phone number country code, country dial code and number type

Endpoint ID:6010
Method:
Status
colourGreen
titleGET
URL:

 /services/phonenumber/parse/{phoneNumber}?countryCode={countryCode}&countryCodeFormat={countryCodeFormat} 

 phoneNumber

Phone number to be validated.

Valid examples

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

Optional value to identify country of phoneNumber.

 countryCodeFormat 

Optional value to identify countryCode format.

Valid values are

  • ISO2 ( ISO ISO 3166-1 alpha-2 : two - letter country codes)
  • ISO3 ( ISO ISO 3166-1 alpha-3 : three - letter country codes)
  • ISON ( ISO ISO 3166-1 numeric : three - digit country codes)
  • Internet (top level domain names on web)
  • Custom ( used for old phone number beautifier Rubiq (internal RubiqSoft format)
Request body:None

Span
stylewhite-space:pre

Response body:

JSON data with information about the valid phone number 

 

Code Block
titleExample – Parse +4529254029
{
   	"phoneNumber": "+4529254029"
  	 "countryCode": "DK",
	   "countryDialCode": "45",
  	 "numberType": "LandLineFixedLineOrMobile"
}

 

 

    

Status codes:200

Phone number is validated successfully.

 400

The following sub codes may be returned:

 

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

No matching country code found for country code format. 

 

 

 

...

400.4Invalid country code.