Page tree
Skip to end of metadata
Go to start of metadata



Our international Phone Exchange service validates and formats phone numbers for international direct dialing, while returning line type, country code and geocoding information.

URL Endpoints


JSON: 

https://trial.serviceobjects.com/pe2/web.svc/json/GetInternationalExchangeInfo?PhoneNumber=PhoneNumber&Country=Country&LicenseKey=LicenseKey

XML: 

 https://trial.serviceobjects.com/pe2/web.svc/xml/GetInternationalExchangeInfo?PhoneNumber=PhoneNumber&Country=Country&LicenseKey=LicenseKey


GetInternationalExchangeInfo Inputs


Name

Type

Description

PhoneNumber

String

The phone number to be parsed, validated and formatted. The phone number may include extension as well. If no country is provided, the country code should be provided in the phone number.
CountryStringThe Country to be validated using provided phone number. Acceptable Country formats are: ISO2 (Preferred), ISO3, Full Country Name, Variant of Full Country Name, I.P. of region where phone number was collected.

LicenseKey

String

Your license key to use the service.
Sign up for a free trial key at
 https://www.serviceobjects.com/products/phone/phone-exchange

GetInternationalExchangeInfo Outputs


InternationalExchangeInfoResponse

Name

Type

Values

Description

InternationalExchangeInfo

InternationalExchangeInfo[]

VariesArray of InternationalExchangeInfo results. See InternationalExchangeInfo description below.

Error

Error

Varies

Error object indicating why the service could not return a result. See “Errors” page for more information.


InternationalExchangeInfo

Name

Type

Description

PhoneNumberIn

String

The phone number that was provided as input.

CountryCode

String

The country code of the provided phone number.

FormatNational

String

The provided phone number in a national format.

Extension

String

The parsed extension from the provided phone number.
LocalityStringThe locality from where the phone number belongs. The locality format is generally Locale/Region, Region or Country.
LocalityMatchLevelStringThe match level that was determined from the locality that was found. Possible values include (Locale/Region, Region, Country) match.
TimeZoneStringThe Time Zone of the validated phone number

Latitude

String

The latitude of the locality determined from the phone number.

Longitude

String

The longitude of the locality determined from the phone number.

CountryStringThe country to which the validated phone number belongs.
CountryISO2StringThe ISO 2 character country designation for a validated phone number.
CountryISO3StringThe ISO 3 character country designation for a validated phone number.
FormatInternationalStringThe provided phone number in international format.
FormatE164StringThe provided phone number in E.164 format.
LineTypeStringThe linetype determined for the phone number. See InternationalExchangeInfo LineType table below.
SMSAddressStringThe SMS gateway address for the provided mobile number
MMSAddressStringThe MMS gateway address for the provided mobile number
IsValidBooleanA boolean response type determining whether the phone number is a valid phone number.
IsValidForRegionBooleanA boolean response type determining whether the phone number is a valid phone number for the provided Country.
NoteCodesStringThe corresponding codes which match NoteDescriptions. These values vary from 1 to 6 based on test results. See Codes, Notes and Corrections.
NoteDescriptionsStringThe corresponding descriptions which match NoteCodes. These values vary based on NoteCodes. See Codes, Notes and Corrections.


Line Types


NameDescription
UNKNOWNThe line type could not be determined for the given phone number.
PREMIUM_RATEThe phone number is assigned at a premium rate. Typically goods or services are charged to the phone number.
TOLL_FREEThe phone number is assigned as a toll-free number
SHARED_COSTThe phone number is assigned as shared cost. A call to this number is shared by the recipient.
VOIPThe phone number is registered to a VOIP provider.
PERSONAL_NUMBERThe phone number is registered as a personal number.
PAGERThe phone number is registered to a pager device.
UANThe phone number is registered as a Universal Access Number.
VOICEMAILThe phone number is registered to a voicemail service.
FIXED_LINEThe phone number is registered to a fixed line provider (POTS).
FIXED_LINE_OR_MOBILEThe phone number is registered to a carrier that offers Fixed and Mobile services.
MOBILEThe phone number is registered to a carrier that offers Mobile services.


References

  • No labels