Метод проверки spam_check_cms - проверка по чёрным спискам для CMS

Метод делает короткую проверку по Blacklist Database, используя антиспам ключ. Он возвращает единственное поле "appears".

Необходимые GET параметры при вызове:

method_name - должен быть 'spam_check_cms',
auth_key - антиспам ключ. Чтобы получить ключ, зарегистрируйтесь здесь: https://cleantalk.org/register?platform=antispam.

Необязательные GET параметры:

ip - ip адрес для проверки (IPv4 или IPv6 в стандартном текстовом виде виде)
email - email адрес для проверки (Результат выдается за последние 6 месяцев)
date - дата в формате YYYY-MM-DD, используется при необходимости указания конкретного дня, за который требуется подсчитать статистику (только для IP адресов.)

Пример запроса c IP:

https://api.cleantalk.org/?method_name=spam_check&auth_key=123456&email=stop_email@example.com&ip=127.0.0.1

Пример запроса c date:

https://api.cleantalk.org/?method_name=spam_check_cms&auth_key=123456&ip=127.0.0.1&date=2017-01-31

API возвращает JSON строку, например:

{"data":{"127.0.0.1":{"appears":0}}}

Расшифровка ответа:

data - обычно массив проверенных записей представлен в следующем формате: "record": {массив проверенных результатов}. Иногда ответ "data" возвращает строку "In progress", это означает, что параллельный PHP-процесс работает с точно такими же параметрами - auth_key, method_name и records.

Важно! Ответ "In progress" является значимым его следует учитывать, так как если вызов API содержит большое количество элементов, то они могут быть проверены частично и выдастся ответ "In progress". Только при повторном вызове будут проверены все оставшиеся элементы.

Массив с проверенными записями содержит следующие поля:

appears - флаг присутствия в черных списках (показывает блокировку на настоящий момент),

В случае указания параметра "date" данные ответа приводятся только на указанную дату. Посредством POST запроса можно за один раз отправить на проверку до 1000 записей.

Если не было активности с адреса в течение 14 дней, то запись удаляется из черных списков, но вся история остаётся.

Проверка нескольких записей

Вы можете отправить несколько записей для теста за 1 раз, для этого используйте POST параметры:

data - строка с записями для проверки разделенная ','.

Например,

wget -O- --post-data='data=stop_email@example.com,10.0.0.1,10.0.0.2' https://api.cleantalk.org/?method_name=spam_check_cms\&auth_key=123456

Ответ:

{"data":{"stop_email@example.com":{"appears":1},"10.0.0.1":{"appears":0},"10.0.0.2":{"appears":0}}}

Ограничения

Если вы превысите максимальное количество вызовов, API вернет ошибку, например,

{"error_message":"Calls limit exceeded.","error_no":10}

Сейчас максимальное количество вызовов установлено в 100 вызовов за 60 секунд.

Если вы превысите максимальное количество элементов данных в методе spam_check вызовов, API вернет ошибку, например,

{"error_message":"Recevied 1001 records to check, maximum 1000 records check perl call.","error_no":8}

Сейчас максимальное количество элементов данных установлено в 1000.

Рекомендуемый таймаут - не более 180 секунд.

Ошибки при анализе и обработке данных возвращаются индивидуально для каждой записи, например,

{"data":{"10.0.0.3":{"error":"Database error"}}}

{"data":{"10.0.0.266":{"error":"Can't check this record: Wrong format"}}}

Примечание: Если в запросе передается дата, то время выполнения этого запроса будет немного увеличено.

Особенности проверки адресов gmail.com

Если почтовый адрес из gmail.com и содержит точки, то проверка выполняется для почты без точек (т.к. это одно и то же для gmail.com), вывод дополняется полем "email" без точек:

https://api.cleantalk.org/?method_name=spam_check_cms&auth_key=123456&email=1234.test.te@gmail.com