- Проверить книгу
- Получить прогресс проверки книги
- Получить результат проверки книги
- Получить список проверенных книг
- Удалить результат проверки книги
- Проверить адрес
- Получить результат проверки адреса
- Удалить результат проверки адреса
- Создать отчет проверки адресной книги
- Просмотреть отчет проверки книги
- Скачать отчет проверки книги
Проверить книгу
Чтобы отправить книгу на проверку, отправляется POST-запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/send-list-to-verify |
Параметры запроса:
id | Идентификатор книги, которую нужно проверить |
Пример запроса:
|
Параметр ответа:
result | Результат проверки: завершена — true, не завершена — false |
Обратите внимание, что запустить несколько проверок на одну и ту же книгу одновременно нельзя. Нужно дождаться окончания первой проверки. Проверить прогресс проверки можно методом Получить прогресс проверки книги.
Если вы отправляете книгу на повторную проверку, в нее должны быть добавлены новые адреса. Проверка осуществляется только по книге, на которую не было рассылок. Также обращайте внимание на срок действия вашего текущего плана и количество доступных проверок.
Пример ответа:
|
Для просмотра результата проверки используйте метод Получить результат проверки книги.
Получить прогресс проверки книги
Чтобы получить прогресс проверки адресной книги, отправляется GET-запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/get-progress/?id={id} |
Параметры запроса:
id |
Идентификатор книги, которая проверяется |
Параметры ответа:
result | Результат проверки: завершена — true, не завершена — false |
data | Данные о проверках |
total | Всего проверок |
processed | Сколько проверок завершены |
Пример ответа:
|
Получить результат проверки книги
Чтобы получить список адресов из книги с результатом проверки, отправляется GET-запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/check/?id={id} |
Параметры запроса:
id | Идентификатор книги, которую проверили |
Обратите внимание, что методы следует использовать попарно: сначала нужно использовать метод «Проверить книгу», затем «Получить результат проверки книги». В противном случае вы получите ответ false.
Параметры ответа:
id | Идентификатор книги |
address_book_name | Название книги |
all_email_quantity | Количество активных адресов в книге |
status |
Статус проверки |
check_date | Дата проверки |
data |
0 — количество непроверенных адресов (серые); 1 — количество действительных адресов (зеленые); 2 — количество неподтвержденных адресов (желтые); 3 — количество недействительных адресов (красные). |
|
1 — в книгу были добавлены новые адреса после проверки 0 — по книге не было проверки |
|
Статус проверки |
|
Информация об адресах |
|
Идентификатор адреса |
|
Адрес электронной почты |
|
Дата проверки |
|
Статус проверки |
|
Текстовое описание статуса |
|
Количество проверок в книге |
Пример ответа:
|
Получить список проверенных книг
Чтобы получить список проверенных адресных книг, отправляется GET-запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/check-list |
Параметры запроса:
start | С какой записи выводить результат; по умолчанию 0. Необязательный параметр |
count | Количество записей, по умолчанию 10. Необязательный параметр |
Параметры ответа:
|
|
list | Список книг |
id | Идентификатор книги |
address_book_name | Название книги |
all_emails_quantity | Количество активных электронных адресов в книге |
status |
Статус проверки адресной книги |
check_date | Дата проверки |
data | 0 — количество непроверенных адресов (серые); 1 — количество действительных адресов (зеленые); 2 — количество неподтвержденных адресов (желтые); 3 — количество недействительных адресов (красные). |
|
|
|
Статус проверки |
|
В книге есть ранее проверенные адреса — true, по книге не было проверки — false |
Пример ответа:
|
Удалить результат проверки книги
Чтобы удалить результат проверки адресной книги, отправляется POST-запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/delete-list-result |
Параметры запроса:
id | Идентификатор книги для которой нужно удалить результат проверки |
Пример запроса:
|
В случае успешного запроса сервер вернет ответ:
|
Проверить адрес
Чтобы проверить один адрес, отправляется POST запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/send-single-to-verify/ |
Параметры запроса:
Электронный адрес, который нужно проверить |
Пример запроса:
|
В случае успешного запроса сервер вернет ответ:
|
Для просмотра результата проверки используйте метод "Получить результат проверки адреса" (см. ниже).
Получить результат проверки адреса
Чтобы получить результат проверки адреса, отправляется GET-запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/get-single-result/?email={email} |
Параметры запроса:
Электронный адрес, который проверяли |
Обратите внимание, что методы следует использовать попарно: cначала нужно использовать метод «Проверить адрес», затем «Получить результат проверки адреса». В противном случае вы получите ответ false.
Параметры ответа:
result | Результат проверки |
data | Данные проверки |
Адрес электронной почты | |
checks | Данные по проверке |
status | Статус проверки |
valid_format |
|
disposbale |
|
webmail |
|
gibberish |
|
status_text | Текстовое описание статуса проверки |
Пример ответа:
|
Удалить результат проверки адреса
Чтобы удалить результат проверки одного адреса, отправляется POST запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/delete-single-result |
Параметры запроса:
Электронный адрес для которого нужно удалить результат проверки |
Пример запроса:
|
В случае успешного запроса сервер вернет ответ:
|
Создать отчет проверки адресной книги
Чтобы создать отчет c результатами проверки адресной книги, отправляется POST-запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/make-report |
Параметры запроса:
id | Идентификатор книги, которую проверяли |
format |
Формат отчета, допустимые значения:
По умолчанию |
status |
С какими статусами должны быть адреса в отчете:
По умолчанию |
lang | Язык отчета. Необязательный параметр |
Пример запроса:
|
В случае успешного запроса сервер вернет ответ:
|
Просмотреть отчет проверки книги
Чтобы просмотреть отчет c результатами проверки адресной книги, отправляется GET-запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/check-report?id={id} |
Параметры запроса:
id | Идентификатор книги, для которой создали отчет |
format |
Формат отчета, допустимые значения:
По умолчанию |
Обратите внимание, что методы следует использовать последовательно: cначала нужно использовать метод «Создать отчет», затем «Получить отчет проверки» и «Cкачать отчет». В противном случае вы получите ответ false.
Параметры ответа:
id | Идентификатор книги |
address_book_name | Название книги |
all_emails_quantity |
|
status | Статус проверки |
check_date | Дата проверки |
data | Данные по проверке |
is_updated |
|
status_text | Текстовое описание статуса |
email_addresses | Данные по адресам |
id | Идентификатор адреса |
email_address | Электронный адрес |
check_date | Дата проверки |
status | Статус проверки |
status_text | Текстовое описание проверки |
|
|
Пример ответа:
|
Скачать отчет проверки книги
Чтобы скачать отчет c результатами проверки адресной книги, отправляется GET-запрос по ссылке:
https://mailer-api.i.bizml.ru/verifier-service/get-report?id={id} |
Параметры запроса:
id | Идентификатор книги, для которой создали отчет |
format |
Формат отчета, допустимые значения:
По умолчанию |
В случае успешного запроса получите список адресов и статус проверки каждого в выбранном формате.
Обратите внимание, что после скачивания отчета он будет удален из базы. При повторной попытке получения отчета получите ответ false
.