Global Phone:Request

← Global Phone

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 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.

URL

REST and JSON

Use	URL
Standard	http://globalphone.melissadata.net/v4/WEB/GlobalPhone/doGlobalPhone
Secure	https://globalphone.melissadata.net/v4/WEB/GlobalPhone/doGlobalPhone

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
Record ID	Record		RecordID
Phone Number		phone	PhoneNumber
Country		ctry	Country
Country Of Origin		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

License Key

Required.

This is a string value containing the License Key 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 License Key, 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

CallerID

US and Canada Only.

Returns the name or association linked to the phone number at the time of registration, if available.

Option Name	Parameter	Description
CallerID	False	Default. CallerID is turned off.
	True	Adds the CallerID to the queried phone, if we found it to be valid.

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

ENABLEBATCHSUGGESTION (Batch Mode Only)

Automatically and aggressively correct invalid phone numbers using the suggestions engine when sending multiple record requests. When there is only one match returned from the suggestions engine in batch mode, Global Phone will automatically resolve the input phone number to that country.

Option Name	Parameter	Description
ENABLEBATCHSUGGESTION	False	Default. Suggestions Engine off.
	True	Enables records to be corrected using the suggestions engine when there is exactly only 1 suggestion found.

TimeToWait

Determines how long the service takes to query a phone number for Premium or CallerID, before it decides to time out.

Time to wait in seconds. Minimum value is 1, maximum value is 30.

Option Name	Parameter	Description
TimeToWait	(Time in seconds)	Default is 2. Time to wait in seconds.

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