Our domestic (USA/Canada) Phone Exchange service returns comprehensive carrier and exchange information, including ported status, SMS and MMS details and identifies high-risk VOIP and prepay phones.
URL Endpoints
- JSON:
- XML:
GetExchangeInfo Inputs
| Name | Type | Description |
|---|---|---|
| PhoneNumber | String | The ten-digit phone number to validate. The input can also expect 7 digit or a 6 digit (area code + suffix) number to return multiple providers. |
| 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 |
GetExchangeInfo Outputs
- All responses from GetExchangeInfo will be returned within an ExchangeInfoResponse object. If no errors are found while performing the validation an Array of ExchangeInfo element will be returned with the following information in an ExchangeInfoResults element. If a 6 digit (area code + suffix) number match is found then multiple provider elements within the ExchangeInfoResults element will be returned. If there is an error, an Error object will be returned (explained in next section).
- ExchangeInfoResponse
| Name | Type | Description |
|---|---|---|
| ExchangeInfoResults | ExchangeInfo[] | Array of ExchangeInfo results. See ExchangeInfo description below. |
| Error | Error | Error object indicating why the service could not return a result. See “Errors” page. |
| Debug | String[] | Array of String type. Used for internal service diagnostics. |
- ExchangeInfo
| Name | Type | Description |
|---|---|---|
| PhoneNumber | String | The verified phone number. |
| Name | String | The name of the phone carrier associated with the phone number. |
| City | String | The city in which the validated phone number is registered. (Ported Numbers will show original location here.) |
| State | String | The state in which the validated phone number is registered. (Ported Numbers will show original location here.) |
| Country | String | The country in which the validated phone number is registered. (Ported Numbers will show original location here.) |
| LineType | String | The line type of the validated phone number. (Possible values are Wireless, Landline and VOIP). |
| TimeZone | String | The Time Zone of the validated phone number |
| Latitude | String | The latitude of the registered carrier location. (Ported Numbers will show original location here.) |
| Longitude | String | The longitude of the registered carrier location. (Ported Numbers will show original location here.) |
| SMSAddress | String | The SMS gateway address for the provided mobile number |
| MMSAddress | String | The MMS gateway address for the provided mobile number |
| PortedInfo | PortedInfo[] | See PortedInfo Description. This object will be populated if the phone number has been ported |
| NoteCodes [1] | String | The corresponding codes which match NoteDescriptions. These values vary from 1 to 6 based on test results. See Notes. |
| NoteDescriptions | String | The corresponding descriptions which match NoteCodes. These values vary based on NoteCodes. See Notes. |
- PortedInfo
| Name | Type | Description |
|---|---|---|
| OriginalName | String | The original carrier name that the provided phone number was ported from. |
| OriginalLineType | String | The original line type that the provided phone number was ported from. |
| PortedDate | String | The date the provided phone number was ported to current carrier. |
| LATA | String | The provided 3 digit Local Access and Transport Area code for the ported phone number. |