API для проверки email адресов

Проверить адресную книгу

Чтобы отправить книгу на проверку, отправьте POST запрос по ссылке:

https://api.sendpulse.com/verifier-service/send-list-to-verify/

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

Параметр	Тип	Описание
id	int	ID адресной книги, которую нужно проверить	required

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

{
   "id":89165888
}

Обратите внимание, что запустить несколько проверок на одну и ту же книгу одновременно невозможно. Нужно дождаться окончания первой проверки. Проверить прогресс проверки можно методом «Получить прогресс проверки адресной книги».

Если вы отправляете книгу на повторную проверку, в нее должны быть добавлены новые адреса. Проверка осуществляется только по книге, на которую не было рассылок. Также обращайте внимание на срок действия вашего текущего плана и количество доступных проверок.

В случае успешного запроса вы получите ответ:

{
    "result": true
}

Для просмотра результата проверки используйте метод «Получить результат проверки адресной книги».

Получить прогресс проверки адресной книги

Чтобы получить прогресс проверки адресной книги, отправьте GET запрос по ссылке:

https://api.sendpulse.com/verifier-service/get-progress/?id={id}

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

Параметр	Тип	Описание
id	int	ID адресной книги, которая проверяется	required

В случае успешного запроса вы получите ответ:

{
    "result": true,
    "data": {
        "total": 22,
        "processed": 22
    }
}

Получить результат проверки адресной книги

Чтобы получить список адресов из книги с результатом проверки, отправьте GET запрос по ссылке:

https://api.sendpulse.com/verifier-service/check/?id={id}

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

Параметр	Тип	Описание
id	int	ID адресной книги, которую проверили	required

Обратите внимание, что методы следует использовать попарно: cначала нужно использовать метод «Проверить адресную книгу», затем «Получить результат проверки адресной книги». В противном случае вы получите ошибку false.

В случае успешного запроса вы получите ответ:

{
    "id": 89163337,
    "address_book_name": "Новая адресная книга",
    "all_emails_quantity": 5, //количество активных емейлов в книге
    "status": 1,
    "check_date": "2020-11-19 13:42:11",
    "data": {
        "0": 0, // количество непроверенных адресов (серые)
        "1": 5, // количество действительных адресов (зеленые)
        "2": 1, // количество неподтвержденных адресов (желтые)
        "3": 0 // количество недействительных адресов (красные)
    },
    "is_updated": 0, // 1 - в книгу были добавлены новые адреса после проверки, 0 - по книге не было проверки
    "status_text": "Зелёный", 
    "email_addresses": [
        {
            "id": 10417371353,
            "email_address": "example1@mail.ru",
            "check_date": "2020-11-19 13:41:20",
            "status": 1,
            "status_text": "Действительный адрес"
        },
        {
            "id": 10417371352,
            "email_address": "example2@ukr.net",
            "check_date": "2020-11-19 13:41:23",
            "status": 1,
            "status_text": "Действительный адрес"
        },
        {
            "id": 10417371349,
            "email_address": "example3@gmail.com",
            "check_date": "2020-11-19 13:41:20",
            "status": 1,
            "status_text": "Действительный адрес"
        },
        {
            "id": 10417371347,
            "email_address": "example4@gmail.com",
            "check_date": "2020-11-19 13:41:21",
            "status": 1,
            "status_text": "Действительный адрес"
        },
        {
            "id": 10417371345,
            "email_address": "example5@rambler.ru",
            "check_date": "2020-11-19 13:41:20",
            "status": 1,
            "status_text": "Действительный адрес"
        }
    ],
    "email_addresses_total": 5 // количество проверок в книге
}

Возможные статусы адреса:

Код	Описание
0	Непроверенный адрес (адрес добавился после проверки)
1	Действительный адрес
2	Неподтвержденный адрес
3	Недействительный адрес

Получить список проверенных адресных книг

Чтобы получить список проверенных адресных книг, отправьте GET запрос по ссылке:

https://api.sendpulse.com/verifier-service/check-list

Параметры запроса:

Параметр	Тип	Описание
start	int	С какой записи выводить результат; по умолчанию `0`	optional
count	int	Количество записей, по умолчанию `10`	optional

В случае успешного запроса вы получите ответ:

{
    "total": 2, // количество проверенных адресных книг
    "list": [
        {
            "id": 89114118,
            "address_book_name": "Mailing list 1",
            "all_emails_quantity": 20, //количество активных емейлов в книге
            "status": 1, // статус проверки адресной книги
            "check_date": "2020-11-23 14:28:14", // дата проверки
            "data": {
                "0": 0, // количество непроверенных адресов (серые)
                "1": 21, // количество действительных адресов (зеленые)
                "2": 1, // количество неподтвержденных адресов (желтые)
                "3": 0 // количество недействительных адресов (красные)
            },
            "is_updated": 0, // 1 - в книгу были добавлены новые адреса после проверки, 0 по книге не было проверки
            "status_text": "Зеленый",
            "is_garbage_in_book": false // true в книге есть ранее проверенные адреса, false по книге не было проверки
        },
        {
            "id": 89163340,
            "address_book_name": "Mailing list 2",
            "all_emails_quantity": 2, //количество активных емейлов в книге
            "status": 1,
            "check_date": "2020-11-19 13:43:11",
            "data": {
                "0": 0, // количество непроверенных адресов (серые)
                "1": 2, // количество действительных адресов (зеленые)
                "2": 0, // количество неподтвержденных адресов (желтые)
                "3": 0 // количество недействительных адресов (красные)
            },
            "is_updated": 1, // 1 - в книгу были добавлены новые адреса после проверки, 0 по книге не было проверки
            "status_text": "Зелёный, обновлён",
            "is_garbage_in_book": true // true в книге есть ранее проверенные адреса, false по книге не было проверки
        }
    ]
}

Возможные статусы адресных книг:

Код	Название	Описание
1	Зеленый	Может содержать небольшой процент невалидных и неподтвержденных адресов, но в целом список считается «качественным»
2	Желтый	Содержит небольшой процент невалидных адресов и много неподтвержденных адресов
3	Красный	Содержит большой процент невалидных адресов

Удалить результат проверки адресной книги

Чтобы удалить результат проверки адресной книги, отправьте POST запрос по ссылке:

https://api.sendpulse.com/verifier-service/delete-list-result

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

Параметр	Тип	Описание
id	int	ID адресной книги для которой нужно удалить результат проверки	required

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

{
   "id":89165888
}

В случае успешного запроса вы получите ответ:

{
    "result": true
}

Проверить адрес

Чтобы проверить один адрес, отправьте POST запрос по ссылке:

https://api.sendpulse.com/verifier-service/send-single-to-verify/

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

Параметр	Тип	Описание
email	string	Email адрес, который нужно проверить	required

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

{
   "email":"user@example.com"
}

В случае успешного запроса вы получите ответ:

{
    "result": true
}

Для просмотра результата проверки используйте метод «Получить результат проверки адреса».

Получить результат проверки адреса

Чтобы получить результат проверки адреса, отправьте GET запрос по ссылке:

https://api.sendpulse.com/verifier-service/get-single-result/?email={email}

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

Параметр	Тип	Описание
email	string	Email адрес, который проверяли	required

Обратите внимание, что методы следует использовать попарно: cначала нужно использовать метод «Проверить адрес», затем «Получить результат проверки адреса». В противном случае вы получите ошибку false.

В случае успешного запроса вы получите ответ:

{
    "result": true,
    "data": {
        "email": "example1@gmail.com",
        "checks": {
            "status": 1,
            "valid_format": 1, // 1, если формат адреса правильный, то есть содержит допустимые символы в правильном порядке
            "disposable": 0, //1, если адрес предоставлен одноразовой службой электронной почты
            "webmail": 0, //1, если адрес предоставлен службой электронной почты
            "gibberish": 0, //1, если адрес сгенерирован автоматически
            "status_text": "Действительный адрес"
        }
}

Удалить результат проверки адреса

Чтобы удалить результат проверки одного адреса, отправьте POST запрос по ссылке:

https://api.sendpulse.com/verifier-service/delete-single-result

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

Параметр	Тип	Описание
email	string	Email адрес для которого нужно удалить результат проверки	required

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

{
   "email":"user@example.com"
}

В случае успешного запроса вы получите ответ:

{
    "result": true
}

Создать отчет проверки адресной книги

Чтобы создать отчет c результатами проверки адресной книги, отправьте POST запрос по ссылке:

https://api.sendpulse.com/verifier-service/make-report

Параметры запроса:

Параметр	Тип	Описание
id	int	ID адресной книги, которую проверяли	required
format	int	Формат отчета, может принимать значения `2` — csv, `3` — xls, `4` — xlsx; по умолчанию `2`	optional
status	array	json_encoded массив, адреса с какими статусами должны быть в отчете `0` — непроверенные, `1` — действительные, `2` — неподтвержденные, `3` — недействительные; по умолчанию `[1]`	optional
lang	string	Язык отчета	optional

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

{
   "id":89165888,
   "format":2,
   "status":"[1,2,3]",
   "lang":"ru"
}

В случае успешного запроса вы получите ответ:

{
 "result": true
}

Просмотреть отчет проверки адресной книги

Чтобы просмотреть отчет c результатами проверки адресной книги, отправьте GET запрос по ссылке:

https://api.sendpulse.com/verifier-service/check-report?id={id}

Параметры запроса:

Параметр	Тип	Описание
id	int	ID адресной книги, для которой создали отчет	required
format	int	Формат отчета, может принимать значения `2` — csv, `3` — xls, `4` — xlsx; по умолчанию `2`	optional

Обратите внимание, что методы следует использовать последовательно: cначала нужно использовать метод «Создать отчет», затем «Получить отчет проверки» и «Cкачать отчет». В противном случае вы получите ошибку «false».

В случае успешного запроса вы получите ответ:

{
    "id": 89165888,
    "address_book_name": "Новый список 1",
    "all_emails_quantity": 10, //количество активных емейлов в книге
    "status": 3,
    "check_date": "2020-11-23 18:02:36",
    "data": {
        "0": 0,
        "1": 3,
        "2": 1,
        "3": 0
    },
    "is_updated": 0, // 1 - в книгу были добавлены новые адреса после проверки, 0 по книге не было проверки
    "status_text": "Желтый",
    "email_addresses": [
        {
            "id": 10422192143,
            "email_address": "user@example.com",
            "check_date": "2020-11-23 18:01:35",
            "status": 3,
            "status_text": "Неподтвержденный адрес"
        },
        {
            "id": 10422192131,
            "email_address": "user2@example.com",
            "check_date": "2020-11-23 18:01:35",
            "status": 1,
            "status_text": "Действительный адрес"
        },
        {
            "id": 10422192128,
            "email_address": "user3@example.com",
            "check_date": "2020-11-23 18:01:34",
            "status": 1,
            "status_text": "Действительный адрес"
        },
        {
            "id": 10422192125,
            "email_address": "user4@example.com",
            "check_date": "2020-11-23 18:01:35",
            "status": 1,
            "status_text": "Действительный адрес"
        }
    ],
    "email_addresses_total": 4 // количество проверок в книге
}

Скачать отчет проверки адресной книги

Чтобы скачать отчет c результатами проверки адресной книги, отправьте GET запрос по ссылке:

https://api.sendpulse.com/verifier-service/get-report?id={id}

Параметры запроса:

Параметр	Тип	Описание
id	int	ID книги, для которой создали отчет	required
format	int	Формат отчета, может принимать значения `2` — csv, `3` — xls, `4` — xlsx; по умолчанию `2`	optional

В случае успешного запроса вы получите список адресов и статус проверки каждого в выбранном формате.

Обратите внимание, что после скачивания отчета он будет удален из базы. При повторной попытке получения отчета получите ответ false.