6011: Format

Format phone number.

Endpoint ID:

6010

Method:

GET

URL:

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

phoneNumber

Phone number to be formatted.

Valid examples

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

Request body:

None

Response body:

JSON data with information about the valid phone number

Example – Format +4529254029 as Intennational

{
	"phoneNumber":+45 29 25 40 29
}

Status codes:

200

Phone number is validated successfully.

400

The following sub codes may be returned:

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

404

No matching country code found for country code format.