Difference between revisions of "Global Phone:Request"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 44: Line 44:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||“TransmissionReference”:”string"
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|-
|-
|REST||?t = {string}
|REST||<code>?t = '''''string'''''</code>
|}
|}


Line 60: Line 60:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"CustomerID”:”string”
|JSON||<code>"CustomerID":"'''''string'''''"</code>
|-
|-
|REST||&id = {string}
|REST||<code>&id = '''''string'''''</code>
|}
|}


Line 74: Line 74:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||"Options”:”string”
|JSON||<code>"Options":"'''''string'''''"</code>
|-
|-
|REST||?opt = {string}
|REST||<code>?opt = '''''string'''''</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 ",".


:<pre><OptionName>:<Parameter>;<OptionName>:<Parameter></pre>
:{| class="alternate01"
!Syntax
|-
|<code>''OptionName'':''Parameter'';''OptionName'':''Parameter''</code>
|}




Line 94: Line 98:
!Option Name !! Parameter
!Option Name !! Parameter
|-
|-
|'''DefaultCallingCode'''||<Country Calling Code>
|'''DefaultCallingCode'''||<code>Country Calling Code</code>
|}
|}


Line 104: Line 108:
!Option Name !! Parameter !! Description
!Option Name !! Parameter !! Description
|-
|-
|rowspan="2"|'''VerifyPhone'''||Express||'''''Default.''''' Quickly validates against a database of known phone numbers.
|rowspan="2"|'''VerifyPhone'''||<code>Express</code>||'''''Default.''''' Quickly validates against a database of known phone numbers.
|-
|-
|Premium||Validates against a database of known phone numbers. If a number was last real-time validated more than 30 days ago, then a real-time check will be performed.
|<code>Premium</code>||Validates against a database of known phone numbers. If a number was last real-time validated more than 30 days ago, then a real-time check will be performed.
|}
|}


Line 130: Line 134:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||“RecordID”:”string”
|JSON||<code>"RecordID":"'''''string'''''"</code>
|}
|}


Line 142: Line 146:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||“PhoneNumber”:”string”
|JSON||<code>"PhoneNumber":"'''''string'''''"</code>
|-
|-
|REST||&phone = {string}
|REST||<code>&phone = '''''string'''''</code>
|}
|}


Line 159: Line 163:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||“Country”:”string”
|JSON||<code>"Country":"'''''string'''''"</code>
|-
|-
|REST||&ctry = {string}
|REST||<code>&ctry = '''''string'''''</code>
|}
|}


Line 175: Line 179:
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||“CountryOfOrigin”:”string”
|JSON||<code>"CountryOfOrigin":"'''''string'''''"</code>
|-
|-
|REST||&ctryOrg = {string}
|REST||<code>&ctryOrg = '''''string'''''</code>
|}
|}


Revision as of 23:01, 4 October 2016

← Global Phone

Global Phone Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
Batch JSON
Result Codes
Result Code Use
Global Phone 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 and at least one input phone number. Though not required, an input country name will greatly increase the chances of recognizing and verifying the phone number in question.

Global Phone supports REST and JSON protocols.


Field Names

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

Field Name Level REST Abbreviation JSON
Transmission Reference Request t TransmissionReference
Customer ID Request id CustomerID
Options Request opt Options
Record ID Record RecordID
Phone Number Record phone PhoneNumber
Country Record ctry Country
Country Of Origin Record ctryOrg CountryOfOrigin


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


Customer ID

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


Options

Optional.
This is a string value containing the options set by the user.
Protocol Syntax
JSON "Options":"string"
REST ?opt = string
List options in the following format, with multiple options delimited with a ",".
Syntax
OptionName:Parameter;OptionName:Parameter


DefaultCallingCode

DefaultCallingCode is used when the country could not be detected from the phone number or country input.
A calling code is a sequence of digits often found after the leading ‘+’ and is unique to a country/region.
By default, this value is blank. For more information on country calling codes, please see: https://en.wikipedia.org/wiki/List_of_country_calling_codes.
Option Name Parameter
DefaultCallingCode Country Calling Code


VerifyPhone

VerifyPhone sets the level of verification to be done on a phone check.
Option Name Parameter Description
VerifyPhone Express Default. Quickly validates against a database of known phone numbers.
Premium Validates against a database of known phone numbers. If a number was last real-time validated more than 30 days ago, then a real-time check will be performed.


Request Record Elements

JSON will only contain the Records element.

Protocol Definition
JSON Each phone number will be contained within [{}] under the Records element.
REST The REST interface only allows a single record per request.


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"


PhoneNumber

Required.
The phone number to be verified
Protocol Syntax
JSON "PhoneNumber":"string"
REST &phone = string


Country

Optional.
The suspected country of the input phone number.
The service accepts the official country name or the ISO2 code.
Some territories will require a different ISO2 code than the one that is given to them. For more information, please see the FAQ.
Protocol Syntax
JSON "Country":"string"
REST &ctry = string


CountryOfOrigin

Optional.
The country from where the verification is being done. If the Country of Origin differs from the Country, then the outputted phone number will be changed to a callable format from the country of origin.
The service accepts the official country name or the ISO2 code. Some territories will require a different ISO2 code than the one that is given to them. For more information, please see the FAQ.
Protocol Syntax
JSON "CountryOfOrigin":"string"
REST &ctryOrg = string
Retrieved from "http://wiki.melissadata.com/index.php?title=Global_Phone:Request&oldid=11694"