TCPA Litigator API
Description
Checks a phone number against one of the largest and most comprehensive databases of known TCPA litigators and serial plaintiffs. Both inbound and outbound call marketers should do this as a best practice.
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": [ { "PhoneIsLitigator": "", "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 scrub results |
"dataOut" Fields
Name | Description |
---|---|
PhoneIsLitigator | 0 = Phone number is not a TCPA litigator 1 = Phone number is a TCPA litigator |
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 |