How to use

The API can return results in json format or in simple format. Use mode = 1 to get detailed results in json format, or mode = 2 to get a simple answer.

GET request format:

https://api.callfilter.app/apis/[API key]/[mode]/[phone number].

Usage examples:

https://api.callfilter.app/apis/**********/1/33162000301
https://api.callfilter.app/apis/**********/2/33162000301
https://api.callfilter.app/apis/**********/1/393391500756
https://api.callfilter.app/apis/**********/2/393391500756

API Responses

When mode = 1 the api gives this result:

{"phone":393391500756,"blocked":1,"cat":8,"comments":15}

Where:

phone is the phone number in international format without the plus sign.
blocked can be 1 (phone number is blocked) and 0 (phone number is not blocked).
cat is the number of category of the number. Possible values:

1 => Scam,
2 => Advertising,
3 => Financial services,
4 => Surveys,
5 => Debt collectors,
6 => Company,
7 => Store,
8 => Other.

comments is the number of reviews of the number in the project database.

If mode = 2 (simple mode) api returns only number: 1 if number is blocked, 0 if number is not blocked.

Restrictions

The free key allows up to 15 requests per minute, the paid key allows up to 120. If the number of requests is exceeded, you will get an error 503. In this case, you will have to repeat the request a little later.

Error codes

503 (Service unavailable) - exceeded limit,
401 (Unauthorized) - invalid key was used,
400 (Bad request) - wrong value in the mode or phone number.