Phone Activity API

Description

Assesses a phone number's activity history over recent months and offers a swift response for phone validation without live connectivity checks.

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

The phone number to validate

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

Response JSON

{
    "success": true,
    "errors": [],
    "dataIn": [
        {
            "PhoneNumber": ""
        }
    ] ,
    "dataOut": [
        {
            "PhoneActivityScore": "",
            "PhoneCarrierName": "",
            "PhoneIsActive": "",
            "PhoneLineType": "",
            "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
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
PhoneCarrierName	The name of the phone carrier
PhoneIsActive	0 = The activity score of the phone number is below 60 1 = The activity score of the phone number is at or above 60
PhoneLineType	FIXED_LINE MOBILE PREPAID TOLL_FREE VOIP OTHER
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