Difference between revisions of "Global Email:Request"

From Melissa Data Wiki
Jump to navigation Jump to search
(Created page with "{{GlobalEmailV4Nav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required e...")
 
Line 12: Line 12:
  
 
==URL==
 
==URL==
{{URL-GlobalEmail}}
+
{{URL-GlobalEmailV4}}
  
  

Revision as of 19:21, 14 March 2019

← Global Email

Global Email Navigation
Basics
Introduction
Licensing
Domain-Only Verification
Privacy and Global Email
Best Practices
FAQ
Service URLs
Input/Output
Request Fields
Response Fields
Examples
REST JSON
REST JSONP
REST XML
Batch XML
Batch JSON
Interpreting Results
Deliverability Confidence Score (Basic)
Result Codes (Advanced)
Global Email Result Codes
Sample Code



A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your Customer ID (License Key) and at least one input email address.

Global Email V4 supports JSON, JSONP, REST, and XML protocols.


URL

REST, XML, JSON, etc.

Use URL
Standard http://globalemail.melissadata.net/v4/WEB/GlobalEmail/doGlobalEmail
Secure https://globalemail.melissadata.net/v4/WEB/GlobalEmail/doGlobalEmail


Field Names

This is a list of the request field names and their protocol naming conventions.

Field Name Level REST JSON
Transmission Reference Request t TransmissionReference
License Key id CustomerID
Options opt Options
Format format Format
Record ID Record RecordID
Email email Email


Request Elements

The following elements set the basic options for each request. These apply to the entire request, not the individual records.

Transmission Reference

Optional.
This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax
JSON "TransmissionReference":"string"
REST ?t = string
XML <TransmissionReference>string</TransmissionReference>


License Key

Required.
This is a string value containing the License Key issued to the customer by Melissa Data for Global Email.
If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa sales representative at 1-800-MELISSA.
Protocol Syntax
JSON "CustomerID":"string"
REST &id = string
XML <CustomerID>string</CustomerID>


Options

Optional.
This is a string value containing the options you set.
Protocol Syntax
JSON "Options":"string"
REST ?opt = string
XML <Options>string</Options>


List options in the following format, with multiple options delimited with a ",".
Syntax
OptionName:Parameter,OptionName:Parameter


VerifyMailBox

VerifyMailBox validates email mailbox.
Option Name Parameter Description
VerifyMailBox Express Default. Also known as fast mode. Quickly validates against database of known email addresses.
Premium Also known as real time mode. Perform real time, live validation of email addresses.


DomainCorrection

DomainCorrection turns on fuzzy correction on suspected email domains typos.
Option Name Parameter Description
DomainCorrection On Default. Activates fuzzy email domain correction if the domain is a suspected typo.
Off No email domain correction.


TimeToWait

TimeToWait allows you to select how long (in seconds) that you would like our web service to wait on a single email before it times out. Select a smaller number if time is of essence, or longer if you would prefer more accurate results.
Option Name Parameter Description
TimeToWait # [5 - 45] Default set to 25. Select how long the web service will wait before it times out on an email.


Format

Optional.
The desired format of the response.
Protocol Syntax
REST &format = string
JSON (HTTP Header) Accept: application/json
XML (HTTP Header) Accept: application/xml


Request Record Elements

JSON will only contain the Records element.

Protocol Definition
JSON Each email will be contained within [{}] under the Records element.
REST The REST interface only allows a single record per request.
XML There will be one RequestRecord element per address being submitted to the Cloud Service.


RecordID

Optional.
This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted.
Protocol Syntax
JSON "RecordID":"string"
XML <RecordID>string</RecordID>


Email

Required.
The email to be verified.
Protocol Syntax
JSON "Email":"string"
REST &email = string
XML <Email>string</Email>