Get started

    API Endpoint

         "<datazapp api endpoint URL>"
                

An Phone Append Service enriches your contact information by adding Cell / Landline numbers through a matching process with the Phone database.

To use this API, you need an API key. Please contact us at [email protected] to get your API key.

File Upload API URL Request

< API Endpoint :-datazapp api endpoint URL>

Sample Request

Request                    
jQuery Sample : 


var form = new FormData();
form.append("ApiKey", "");
form.append("AppendModule", "2");
form.append("AppendType", "2");
form.append("IsDNC", "1");
form.append("fileName", "PhoneAppendTestFileAPI.csv");
form.append("file", fileInput.files[0], "/Z:/Test Files/PhoneAppendTestFileAPI.csv");


var settings = {
  "url": "",
  "method": "POST",
  "timeout": 0,
  "processData": false,
  "mimeType": "multipart/form-data",
  "contentType": false,
  "data": form
};


$.ajax(settings).done(function (response) {
  console.log(response);
});

Parameter	Required	Description	Type
APIKey	required	Issued by sales support or Datazapp Admin	String
AppendModule	required	Value should be 2	String
AppendType	required	Value must be any from below 1. Cell Phone 2. Landline 3. Cell (Priority) or Landline (Max 1 Phone) 4 Cell and/or Landline (Max 2 Phones)	int
IsDNC	required	1 or 0	bool
File Name	required	Name of file	String
file	required	File data attached in form (input file should have following column name format) First,Last,Address,State,ZIP	[filestream]

Response

Query Parameters

Field	Type	Description
Following Parameters Should be send in Header:
Status	Integer	Indicate header status
Message	String	Indicate type of error
Following Parameters Should be send in ResponseDetails:
App
Token	String	System generated reference.
OrderAmount	String	Amount of count
Count	String	Number of count
Message	String	Null
ProcessedTime	String	Processing time
Status	String	True
Message	String	True

File Append Status API Request

< API Endpoint :-datazapp api endpoint URL>

This API requests for status of requested Phone Append File. In return, it will share file status and if the file is processed, it will include order amount and current balance.

Sample Request

Request                    
jQuery Sample : 


var form = new FormData();
form.append("Token", "Reference token");
form.append("ApiKey", "Your API Key");
form.append("AppendModule", "2");


var settings = {
  "url": "",
  "method": "POST",
  "timeout": 0,
  "processData": false,
  "mimeType": "multipart/form-data",
  "contentType": false,
  "data": form
};


$.ajax(settings).done(function (response) {
  console.log(response);
});

Parameter	Required	Description	Type
APIKey	required	Issued by sales support or Datazapp Admin	String
AppendModule	required	Value should be 1	String
Token	required	File Request reference Token returned	String

Sample Response (file in Process)

Sample Response (file is completed)

Response Description

Query Parameters

Field	Type	Description
Following Parameters Should be send in Header:
Status	Integer	Indicate header status
Message	String	Indicate type of error
Following Parameters Should be send in ResponseDetails:
Token	String	File Request reference Token returned
OrderAmount	String	Amount of count
Count	String	Number of count
Message	String	Null
Status	String	True
Message	String	True

File Append Download API Request

< API Endpoint :-datazapp api endpoint URL>

This API requests to purchase and download requested Phone Append File. If the user has enough balance to purchase the requested file, API will process the request, deduct the order amount from his Datazapp Balance and return the file in response.

Sample Request

Request                    
jQuery Sample : 


var form = new FormData();
form.append("Token", "Reference token");
form.append("ApiKey", "Your API Key");
form.append("AppendModule", "1");


var settings = {
  "url": "",
  "method": "POST",
  "timeout": 0,
  "processData": false,
  "mimeType": "multipart/form-data",
  "contentType": false,
  "data": form
};


$.ajax(settings).done(function (response) {
  console.log(response);
});

Parameter	Required	Description	Type
APIKey	required	Issued by sales support or Datazapp Admin	String
AppendModule	required	Value should be 1	String
Token	required	File Request reference Token returned	String

Response

Response Description

Response will be containing CSV file as content-type ‘application/octet-stream’ and content-disposition will have file name.

Errors

The API uses the following error codes:

Error Code	Meaning
Module does not exist.	The specified module does not exist or Invalid AppendModule Name.
User not found.	Invalid API Key or The user associated with the API key was not found
Append Request not found	Invalid Token: The specified append request could not be found
Improper JSON Data. Please check.	The JSON data in the request does not match the expected format.
It seems like API has an issue. Please contact Support.	There is an issue with the API. Contact the [email protected]