Global Email V3:Request: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(11 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{ | {{GlobalEmailV3Nav | ||
|InputOutputCollapse= | |InputOutputCollapse= | ||
}} | }} | ||
Line 6: | Line 6: | ||
{{CustomTOC}} | {{CustomTOC}} | ||
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 and at least one input email address. | 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 supports JSON, JSONP, REST, SOAP, and XML protocols. | Global Email supports JSON, JSONP, REST, SOAP, and XML protocols. | ||
==URL== | |||
{{URL-GlobalEmailV3}} | |||
Line 15: | Line 19: | ||
{| class="alternate01 sortable" | {| class="alternate01 sortable" | ||
!Field Name !! Level !! REST | !Field Name !! Level !! REST !! JSON | ||
|- | |- | ||
|Transmission Reference||Request||t||TransmissionReference | |Transmission Reference||rowspan="4" valign="center"|Request||t||TransmissionReference | ||
|- | |- | ||
| | |License Key||id||CustomerID | ||
|- | |- | ||
|Options | |Options||opt||Options | ||
|- | |- | ||
| | |Format||format||Format | ||
|- | |- | ||
| | |Record ID||rowspan="2" valign="center"|Record|| ||RecordID | ||
|- | |- | ||
| | |Email||email||Email | ||
|} | |} | ||
Line 42: | Line 46: | ||
!Protocol !! Syntax | !Protocol !! Syntax | ||
|- | |- | ||
|JSON | |JSON||<code>"TransmissionReference":"'''''string'''''"</code> | ||
|- | |- | ||
| | |REST||<code>?t = '''''string'''''</code> | ||
|- | |- | ||
|XML||<TransmissionReference>string</TransmissionReference> | |SOAP/XML||<code><TransmissionReference>'''''string'''''</TransmissionReference></code> | ||
|} | |} | ||
<h3 style="background-color:rgb(240,240,240);"> | <h3 style="background-color:rgb(240,240,240);">License Key</h3> | ||
:''Required.'' | :''Required.'' | ||
:This is a string value containing the | :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 | :If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa Data sales representative at 1-800-MELISSA. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
!Protocol !! Syntax | !Protocol !! Syntax | ||
|- | |- | ||
|JSON | |JSON||<code>"CustomerID":"'''''string'''''"</code> | ||
|- | |- | ||
|REST||&id = | |REST||<code>&id = '''''string'''''</code> | ||
|- | |- | ||
|SOAP||< | |SOAP/XML||<code><CustomerID>'''''string'''''</CustomerID></code> | ||
|} | |} | ||
Line 80: | Line 80: | ||
!Protocol !! Syntax | !Protocol !! Syntax | ||
|- | |- | ||
|JSON | |JSON||<code>"Options":"'''''string'''''"</code> | ||
|- | |- | ||
|REST||?opt = | |REST||<code>?opt = '''''string'''''</code> | ||
|- | |- | ||
|SOAP||< | |SOAP/XML||<code><Options>'''''string'''''</Options></code> | ||
|} | |} | ||
:List options in the following format, with multiple options delimited with a ",". | :List options in the following format, with multiple options delimited with a ",". | ||
:< | :{| class="alternate01" | ||
!Syntax | |||
|- | |||
|<code>''OptionName'':''Parameter'',''OptionName'':''Parameter''</code> | |||
|} | |||
:<h4 style="border-bottom:1px solid black;">VerifyMailBox</h4> | :<h4 style="border-bottom:1px solid black;">VerifyMailBox</h4> | ||
:: | ::Validates email mailbox. | ||
::{| class="alternate01 sortable" | ::{| class="alternate01 sortable" | ||
!Option Name !! Parameter !! Description | !Option Name !! Parameter !! Description | ||
|- | |- | ||
|rowspan="2"|'''VerifyMailBox'''||Express||'''''Default.''''' | |rowspan="2"|'''VerifyMailBox'''||<code>Express</code>||'''''Default.''''' Quickly validates against database of known email addresses. | ||
|- | |- | ||
|Premium|| | |<code>Premium</code>||A real time check is performed to determine email deliverability. | ||
|} | |} | ||
:<h4 style="border-bottom:1px solid black;"> | :<h4 style="border-bottom:1px solid black;">DomainCorrection</h4> | ||
:: | ::DomainCorrection turns on fuzzy correction on suspected email domains typos. | ||
::{| class="alternate01 sortable" | ::{| class="alternate01 sortable" | ||
!Option Name !! Parameter !! Description | !Option Name !! Parameter !! Description | ||
|- | |- | ||
|rowspan="2"|''' | |rowspan="2"|'''DomainCorrection'''||<code>On</code>||'''''Default.''''' Activates fuzzy email domain correction if the domain is a suspected typo. | ||
|- | |- | ||
| | |<code>Off</code>||No email domain correction. | ||
|} | |||
:<h4 style="border-bottom:1px solid black;">TimeToWait</h4> | |||
::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. | |||
::{| class="alternate01 sortable" | |||
!Option Name !! Parameter !! Description | |||
|- | |||
|'''TimeToWait'''||<code># [5 - 45]</code>||'''''Default set to 25.''''' Select how long the web service will wait before it times out on an email. | |||
|} | |} | ||
<h3 style="background-color:rgb(240,240,240);">Format</h3> | |||
:: | :''Optional.'' | ||
:The desired format of the response. | |||
:{| class="alternate01" | |||
! | !Protocol !! Syntax | ||
|- | |||
|REST||<code>&format = '''''string'''''</code> | |||
|- | |- | ||
| | |JSON (HTTP Header)||<code>Accept: application/json</code> | ||
|- | |- | ||
| | |SOAP/XML (HTTP Header)||<code>Accept: application/xml</code> | ||
|} | |} | ||
Line 140: | Line 153: | ||
!Protocol !! Definition | !Protocol !! Definition | ||
|- | |- | ||
|JSON | |JSON||Each email will be contained within [{}] under the Records element. | ||
|- | |- | ||
|REST||The REST interface only allows a single record per request. | |REST||The REST interface only allows a single record per request. | ||
|- | |- | ||
|SOAP|| | |SOAP||This element is an array of object variables of the type RequestRecords. | ||
|- | |- | ||
|XML|| | |XML||There will be one RequestRecord element per address being submitted to the Cloud Service. | ||
|} | |} | ||
Line 158: | Line 171: | ||
!Protocol !! Syntax | !Protocol !! Syntax | ||
|- | |- | ||
|JSON|| | |JSON||<code>"RecordID":"'''''string'''''"</code> | ||
|- | |- | ||
|SOAP||< | |SOAP/XML||<code><RecordID>'''''string'''''</RecordID></code> | ||
|} | |} | ||
Line 174: | Line 185: | ||
!Protocol !! Syntax | !Protocol !! Syntax | ||
|- | |- | ||
|JSON | |JSON||<code>"Email":"'''''string'''''"</code> | ||
|- | |- | ||
| | |REST||<code>&email = '''''string'''''</code> | ||
|- | |- | ||
|XML||< | |SOAP/XML||<code><Email>'''''string'''''</Email></code> | ||
|} | |} | ||
[[Category:Global Email]] | [[Category:Global Email V3]] | ||
[[Category:Reference]] | [[Category:Reference]] |
Latest revision as of 21:36, 18 March 2020
Global Email V3 Navigation | ||||||
---|---|---|---|---|---|---|
| ||||||
| ||||||
| ||||||
| ||||||
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 supports JSON, JSONP, REST, SOAP, and XML protocols.
URL
SOAP
Use URL Standard http://globalemail.melissadata.net/v3/SOAP/globalemail Secure https://globalemail.melissadata.net/v3/SOAP/globalemail
REST, XML, JSON, etc.
Use URL Standard http://globalemail.melissadata.net/v3/WEB/GlobalEmail/doGlobalEmail Secure https://globalemail.melissadata.net/v3/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 | |
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
SOAP/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 Data sales representative at 1-800-MELISSA.
Protocol Syntax JSON "CustomerID":"string"
REST &id = string
SOAP/XML <CustomerID>string</CustomerID>
Options
- Optional.
- This is a string value containing the options set by the user.
Protocol Syntax JSON "Options":"string"
REST ?opt = string
SOAP/XML <Options>string</Options>
- List options in the following format, with multiple options delimited with a ",".
Syntax OptionName:Parameter,OptionName:Parameter
VerifyMailBox
- Validates email mailbox.
Option Name Parameter Description VerifyMailBox Express
Default. Quickly validates against database of known email addresses. Premium
A real time check is performed to determine email deliverability.
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
SOAP/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. |
SOAP | This element is an array of object variables of the type RequestRecords. |
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"
SOAP/XML <RecordID>string</RecordID>
- Required.
- The email to be verified
Protocol Syntax JSON "Email":"string"
REST &email = string
SOAP/XML <Email>string</Email>