Getting Started with Hiya Protect
Note: If you're interested in developing using Hiya Protect API or Cache, please request access. This is not a self-service API, and acquiring an API key is currently a manual process. Hiya ensures that the Protect capabilities are used by companies for the right purpose. For that reason, before providing a key, Hiya conducts a Know Your Customer (KYC) verification.
What is Hiya Protect
Hiya Protect is a solution designed to safeguard users from unwanted, fraudulent, and spam calls. By leveraging machine learning and extensive call pattern analysis, Hiya Protect identifies and mitigates nuisance calls before they reach the user. This helps carriers, businesses, and enterprises enhance the call experience while ensuring security and trust in communications. For more on this topic, go here: Hiya Protect Demo.
How Hiya Protect works
Hiya Protect operates by analyzing incoming calls in real-time, utilizing machine learning models and extensive global call data to assess the reputation of each call. This analysis allows for the identification of nuisance and malicious calls, enabling appropriate actions such as notifying subscribers or blocking the calls.
Integration Options
Different use cases may require real-time integration via the API, a locally stored cache, or a combination of both. For example, your applicaton may use the API for live call analysis while maintaining a cache for offline lookups and bulk number consumption to enable unique scenarios.
1: Hiya ProtectCache
The Hiya Cache is designed for integrators who prefer to maintain a local server cache of Hiya Protect's data. This approach involves downloading a set of phone numbers with associated reputation levels and categories, allowing for efficient local lookups.
Possible way to use the cache:
-
Local Data Storage: Your application will maintain a local cache of phone numbers with their reputation information for quick access.
-
Scheduled Updates: Your application will regularly update the cache to ensure the data remains current and accurate.
Implementation Steps:
-
Request Cache File: Make a GET request to request for hiya protect cache. A successful request returns a 307 'Temporary Redirect' status with a signed URL. Learn more about the API here
-
Download Cache File: Perform a GET request using the signed URL within 30 seconds to download the gzipped TSV file containing the phone numbers and their reputations.
-
Process Cache Data: Extract and store the data from the TSV file in your local store for use in your call analysis.
2: Hiya Protect REST API
The Hiya REST API provides real-time access to Hiya's services, allowing partners to integrate features such as spam and fraud detection into their applications.
Key Features:
-
Real-Time Call Analysis: Access Hiya's real-time machine-learning models to assess call reputations instantly.
-
Comprehensive Data: Utilize Hiya's extensive global call event data for accurate spam and fraud detection.
Implementation Steps:
-
Lookup Incoming Call: This API should be invoked to indicate that the user is about to receive a phone call and Hiya will respond with the reputation and/or caller name/ID information pertaining to the call.
-
Process API Response: Your application will use the response to provide the right user experience on your end - should analyze Hiya’s response to determine whether the call is categorized as SPAM, SCAM, or neutral.
-
Send Call Event: This API must be invoked to indicate the action taken by the user (answered, declined, blocked, etc.) in response to an incoming or outgoing call. A call may consist of multiple call events, such as being answered and then finished. This information helps improve Hiya’s detection of unwanted or nuisance calls.