Contact Qualification API

Description

Confirms the name associated with a phone number, determines the phone activity and line type, and assesses the level of contactability.

Request URL

https://api.rrdblive.com/DDM/WebService.cfc?method=process

Supported HTTP methods: GET or POST

Authentication Parameters

ClientID	Your "Client ID"
CWSID	Your "Client Web Service ID"
Token	A token that is authorized to process this web service request

Required Parameters

PhoneNumber	Contact's phone number
FirstName	Contact's first name
LastName	Contact's last name

Parameters may be passed as either URL query parameters or posted as FORM fields

Response JSON

{
    "success": true,
    "errors": [],
    "dataIn": [
        {
            "FirstName": "",
            "LastName": "",
            "PhoneNumber": ""
        }
    ] ,
    "dataOut": [
        {
            "ContactabilityLevel": "",
            "FirstName": "",
            "LastName": "",
            "PhoneActivityScore": "",
            "PhoneLineType": "",
            "PhoneNameMatch": "",
            "PhoneNumber": ""
        }
    ]
}

Response Keys

Key	Description
success	"true" if request was successful / "false" if errors occurred
errors	If "success" was "false", will contain an array of error objects. See below for sample error response.
dataIn	The original input data
dataOut	If "success" was "true", will return the phone validation results

"dataOut" Fields

Name	Description
ContactabilityLevel	VERY_HIGH = the phone has been consistently active recently and the provided name matches what is on record for the phone owner. HIGH = the phone is a consistently active mobile number, but the name does not match because the subscriber may be part of a shared phone plan. The contact is still very likely to be high quality. MEDIUM = the phone is valid and the name matches, but the activity has been low or inconsistent. LOW = the phone is valid with low activity, and the name does not match. VERY_LOW = the phone is invalid, inactive, or a VOIP number without an associated owner.
FirstName	Contact's first name
LastName	Contact's last name
PhoneActivityScore	Range from 0 to 100. A score of 100 means consistent activity over the past year and a score of 0 means the number is invalid or likely disconnected
PhoneLineType	FIXED_LINE MOBILE PREPAID TOLL_FREE VOIP OTHER
PhoneNamemMatch	0 = The name does NOT match what is on record for the phone number 1 = The name matches the phone number (first or last)
PhoneNumber	Standardized phone number

Sample Error Response JSON

{
    "success": false,
    "errors": [
        {
            "errorID": 1000,
            "errorHeader": "Authentication Failed",
            "errorMessage": "API user access denied"
        }
    ]
}

4xx HTTP Status Code will be returned for all of the following:

errorID	errorHeader	errorMessage
400	API Error	Depends on the cause of error
403	API Error	This API supports HTTPS only
500	Unexpected Error	Depends on the cause of error
1000	Authentication Failed	Depends on the cause of error
2000	Validation Error	Required fields are missing or blank
35030	Web Service Error	Active web service was not found
35040	Web Service Error	The supplied Token is not authorized for use with this CWSID
35050	Web Service Error	No data was submitted
35060	Web Service Error	Depends on the cause of error
35070	Web Service Error	This web service supports only one record at a time