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



This operation is a composite of PhoneAppend and BusinessPhoneAppend. CompositePhoneAppend provides the convenience for developers to code to one operation and is able to append phone numbers for business and residential contacts A parameter "IsBusiness" allows the client to specify whether the contact is a business or not. If left blank, the service can make the determination on its own, however, this increases the response time from the request.


CompositePhoneAppend makes use of additional name parsing logic when the IsBusiness parameter is not provided a value of True or False. This additional logic adds an increase in response time due to name-based logic that is performed on the inputs provided. It is recommended to specify a value for the IsBusiness parameter when used in applications that are time sensitive.


URL Endpoints


JSON: https://trial.serviceobjects.com/PA2/api.svc/CompositePhoneInfo/{STATE}/{CITY}/{POSTALCODE}/{ADDRESS}/{NAME}/{ISBUSINESS}/{LICENSEKEY}?format=json


XML: https://trial.serviceobjects.com/PA2/api.svc/CompositePhoneInfo/{STATE}/{CITY}/{POSTALCODE}/{ADDRESS}/{NAME}/{ISBUSINESS}/{LICENSEKEY}?format=xml



CompositePhoneAppend Inputs


Name

Type

Description

Name

String

The Name of the contact to return the telephone number.

Address

String

The Address of the contact to return the telephone number.

City

String

The City of the contact to return the telephone number.

State

String

The State of the contact to return the telephone number.

Postal Code

String

The Postal Code of the contact to return the telephone number.

IsBusiness

String

A determination of the type of contact to append a phone number to. Values to submit are either "True","False" or leave field blank to allow the service to make the determination on its own. We leave this up to the client to make the determination based on how they intend to use the service

LicenseKey

String

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

CompositePhoneAppend Outputs


If no errors are encountered a PhoneInfo element will be returned with the following information. If there is an error, an Error object will be returned (explained in the Errors page).

Name

Type

Description

Phone

String

The landline phone number matching the found contact.

Name

String

The Name of the person matching the found contact

Address

String

The Address of the person matching the found contact.

City

String

The City of the person matching the found contact.

State

String

The State of the person matching the found contact

PostalCode

String

The Postal Code of the person matching the found contact.

IsResidential

String

A determination of the matching contact is a business number or not.

Certainty

String

A rating scale of the accuracy of the matching contact given the supplied inputs. Values can be "Low" "Medium" or "High"

LineTypeStringA determination of the phone carrier line type. Possible values are "Landline", "Wireless", "VOIP", or "Unknown". This operation favors landline results but does have the opportunity to return a small percentage of wireless numbers.

Debug

String

An internal field used for testing our services

ErrorErrorSee Errors


References


  • No labels