RealValidation API Reference

Application Object

class realvalidation.RealValidation(workbooks=None, token=None, output='json', url='https://api.realvalidation.com/rpvWebService/DNCLookup.php', phone_regex='^\d{10}$', staging=False)

RealValidation Application Object

Parameters:

• workbooks (list) – List of workbook paths to validate against RealValidation DNC API
• token (str) – RealValidation API Token. Defaults to environmental variable RV_TOKEN
• output (str) – RealValidation API Output. Defaults to json
• url (str) – RealValidation API URL. Defaults to https://api.realvalidation.com/rpvWebService/DNCLookup.php
• phone_regex (str) – Regex to use when validating phone numbers. Defaults to r'^\d{10}$'
• staging (bool) – If True RealValidation utilizes the Mock API, overrides url parameter

lookup_phone(phone)

Makes a request to the RealValidation DNC API

Parameters:phone (str) – 10 numerical digits representing a phone number. Returns:Dictionary representing JSON response from RealValidation DNC API. Return type:dict

lookup_phone_from_row(row, phone_column_index)

Lookup phone from row at index

Parameters:

• row (list) – List of strings containing phone
• phone_column_index (int) – Index/Position of phone in row list

Returns:

True/False value whether phone is on dnc or not

Return type:

bool

lookup_phones_from_workbooks()

Validates Workbooks against RealValidation DNC API

Returns:Dictionary with values of valid and invalid rows Return type:dict

Utilities

realvalidation.utils.enumerate_phone_column_index_from_row(row)

Enumerates the phone column from a given row. Uses Regexs

Parameters:row (list) – list of cell values from row Returns:phone column index enumerated from row Return type:int

realvalidation.utils.get_cell_values_from_row(row)

Returns string representation of cell values from row in a list

Parameters:row (list) – list of values Returns:string representation of cell values from row in a list Return type:list

realvalidation.utils.is_dnc_json_response_on_dnc(response)

Determines if json response from DNC API is on dnc

Parameters:response (dict) – dictionary response from RealValidation DNC API Returns:True/False value whether response is on DNC or not Return type:bool

realvalidation.utils.is_value_phone_identifier(value)

Returns True/False whether value is [Pp]hone or 10 numerical digits only

Parameters:value (str) – Value to determine if phone identifier Returns:True/False value whether phone is a valid identifier Return type:bool

realvalidation.utils.sanitize_phone(phone, regex='[^0-9]')

Uses regex sub to sanitize characters from phone

Parameters:

• phone (str) – Phone string to sanitize
• regex (regex) – Regex to use to sub characters from string. Defaults to r'[^0-9]'

Returns:

sanitized phone string

Return type:

str

realvalidation.utils.write_rows_to_workbook(rows, workbook_path, workbook_name)

Writes row to workbook

Parameters:

• rows (list) – list of rows to write to workbook
• workbook_path (str) – Path to write workbook to
• workbook_name (str) – Name of the workbook

Errors

exception realvalidation.errors.InvalidJSONResponseError

Raised when we couldn’t decode a JSON response from a RealValidation API Request

exception realvalidation.errors.InvalidPhoneFormatError

Raised when a phone string doesn’t match PHONE_REGEX

exception realvalidation.errors.InvalidTokenError

Raised when a token couldn’t be enumerated. Tokens can passed as a parameter when initializing a RealValidation object or by setting the RV_TOKEN environmental variable before execution.

exception realvalidation.errors.RealValidationError

Base class for exceptions in this module.

exception realvalidation.errors.ResponseCodeNotOkError

Raised when RESPONSECODE in a RealValidation JSON response does not equal OK