API метод email_check

• Общие замечания
• Get параметры метода
• Расшифровка ответа
• Проверка нескольких записей

Для использования метода EMAIL_CHECK необходимо приобрести отдельную лицензию — BlackList API. Цены можно посмотреть здесь: https://cleantalk.org/price-database-api

Приобрести можно на вашей странице биллинга в Панели Управления: https://cleantalk.org/my/bill/api

Результаты метода содержат информацию о существовании адреса e-mail.

Примечание: на серверах CleanTalk учитывается каждая запись, отправленная на проверку. Если вы сделали 1 запрос с несколькими записями, то в Панели Управления CleanTalk вы увидите столько проверок на счётчике, сколько было отправлено записей. 

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

• method_name — должен быть 'email_check'
• auth_key — ключ Database API. Чтобы получить ключ, зарегистрируйтесь здесь: https://cleantalk.org/register?platform=api

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

• email — адрес email для проверки
• email_<SHA256> - хэш SHA256 адреса email. Обратите внимание, что восстановить адрес по хэшу невозможно, поэтому результат будет успешным, если хэш уже есть в нашей базе данных.

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

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

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

{"data":{"stop_email@example.com":{"result":"EXISTS"}}}

Пример с хэшем адреса email:

https://api.cleantalk.org/?method_name=email_check&auth_key=pe4ugy3uta3e&email=email_08c2495014d7f072fbe0bc10a909fa9dca83c17f2452b93afbfef6fe7c663631

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

data —массив с проверенными записями, выводимые в формате "запись":{массив с результатами}.

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

• EXISTS — адрес существует,
• NOT_EXISTS — адрес не существует,
• MX_FAIL — невозможно получить информацию об адресе e-mail или домене.
• FAIL — для хэша SHA256. Нет такого хэша в нашей базе или неправильный формат записи.

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

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

• emails — строка с записями для проверки разделенная ','.

Пример:

wget -O- --post-data='emails=stop_email@example.com,s@cleantalk.org' https://api.cleantalk.org/?method_name=email_check&auth_key=123456

Ответ:

{"data":{"s@cleantalk.org":{"result":"NOT_EXISTS"},"stop_email@example.com":{"result":"EXISTS"}}}

При малом количестве записей, чтобы увидеть результаты, возможно потребуется вывод в файл:

wget -O results.txt --post-data='emails=stop_email@example.com,s@cleantalk.org' https://api.cleantalk.org/?method_name=email_check&auth_key=123456

Ограничения

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

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

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

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

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

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

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

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

Вы может задать любой вопрос относительно Анти-Спам от CleanTalk через: