Quickstart#
Introduction#
Welcome to the Melissa Data PhoneLib Service. Verify phone numbers from over 230 countries and append useful geographic information. In North America you can perform premium real-time checks to distinguish live numbers and phone types.
The PhoneLib Service can:
Verify and append country dialing codes, international exit codes, national prefixes, and more.
Append geographic information on the telephone line such as latitude, longitude, administrative area, and language.
Parse the phone number into its various components.
Return Caller ID Information for 200 countries.
Identify the numbers phone type including mobile, landline, VoIP, and more. (North America Only)
Perform a real-time check on a number to know whether it is live or not. (North America Only)
System Requirements#
Melissa Updater (for data files)
Latest Linux containerization technology like Docker.
Getting Started#
To get started with the PhoneLib Service you need to download the necessary data files, spin up a container instance and then send requests to this local instance.
Download the Data Files#
Use Melissa Updater to download the data files using the manifest named dq_phone_data
.
.\MelissaUpdater manifest \
-p "dq_phone_data" \
-r "latest" \
-l "{{LicenseKey}}"
Spin up the Container Instance#
Once you have the proper data files downloaded, you need to set up a containerization service to host the PhoneLib Service on your local machine, like Docker. It will help to have the following readily available:
Data files path
Desired web service listening port for the container
License key
Getting Credentials/Licensing#
The License Key is a software key required to use the service. You will receive your license key from your Melissa representative. If you don’t have a license key, contact the Melissa sales team at sales@melissa.com or 800-MELISSA ext. 3 (800-635-4772 ext. 3). Without a license key this service will not function.
Logging in to Docker#
You must first login to Melissa’s container repository in order to download the PhoneLib Service image:
docker login hub.melissadata.net
You will be prompted for your username and password, this will be where you use the credentials you received from the Melissa sales team.
Example Docker Setup#
docker pull hub.melissadata.net/melissadata/dqt/phonelibservice:latest
docker run -d --name addrlibservice --restart unless-stopped \
-p {{port_number}}:6245 -e {{license_key}} \
-v "{{data_path}}":/data \
hub.melissadata.net/melissadata/dqt/phonelibservice:latest
The first port section
-p {{port_number}}:
can be whatever port you want on your local machine, but the second port (6245
) should stay the same.-v "{{data_path}}":
is the location of the data files on your local machine or server.
What Can I Do?#
Once you have the PhoneLib Service set up in a Docker instance, you can then access it like a Melissa Cloud API with GET or POST requests.
Check the Version#
PhoneLib Service can check the version of the latest available release.
Endpoint#
/V3/WEB/ContactVerify/GetVersion
Click here to go to the full endpoint documentation.
Try it Now#
curl -X GET \
"http://{{machine_name}}:{{port_number}}/V3/WEB/ContactVerify/GetVersion" \
-H "accept: application/json"
Check a Phone Number#
PhoneLib Service can check an address.
Endpoint#
/V3/WEB/ContactVerify/doContactVerify
Click here to go to the full endpoint documentation.
Try it Now#
curl -X GET \
"http://{{machine_name}}:{{port_number}}/V3/WEB/ContactVerify/doContactVerify?\
t=test\
&id={{license_key}}\
&ctry=US\
&a1=22382%20Avenida%20Empresa\
&city=Rancho%20Santa%20Margarita\
&state=CA\
&postal=92688\
&comp=Melissa\
&format=json"\
-H "accept:application/json"
curl -X 'POST' \
'http://{{machine_name}}:{{port_number}}/V3/WEB/ContactVerify/doContactVerify' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"customerId": "{{license_key}}",
"options": "",
"transmissionReference": "test",
"records": [
{
"recordID": "1",
"addressLine1": "22382 Avenida Empresa",
"addressLine2": "",
"suite": "",
"city": "Rancho Santa Margarita",
"state": "CA",
"postalCode": "92688",
"lastLine": "",
"plus4": "",
"deliverypointcode": "",
"company": "Melissa",
"urbanization": "",
"lastName": "",
"country": "US"
}
]
}'