验证电子邮件地址的API

核实邮寄名单

要发送邮件列表以供审核,请发送POST请求到:

https://api.半岛客户端下载官网www.ekobsc.com/verifier-service/send-list-to-verify/

请求参数:

参数 类型 描述
id int 有待核实的邮件列表ID 要求

请求示例:

{"id":89165888}

请注意,您不能同时在同一邮件列表上运行多个验证。你必须等到第一次验证结束。您可以使用“获取邮件列表验证结果”的方法。

如果您要发送邮件列表以重新审核,则必须向其中添加新地址。您只能验证未在活动中使用的邮件列表。还要注意当前计划的到期日期以及可用的验证次数。

如果请求成功,您将收到一个响应:

{"result": true}

要查看验证结果,请使用获取邮件列表验证结果”的方法。

获取邮件列表验证进度

要查看当前正在验证的邮件列表的进度,请发送GET请求到:

https://api.半岛客户端下载官网www.ekobsc.com/verifier-service/get-progress/?id = {id}

请求参数:

参数 类型 描述
id int 正在验证的邮件列表ID 要求

如果请求成功,您将收到一个响应:

{“结果”:真的,“数据”:{“加工”:“总”:22日20}}

获取邮件列表验证结果

要从邮件列表中获取电子邮件地址列表及其验证结果,请向以下地址发送get请求:

https://api.半岛客户端下载官网www.ekobsc.com/verifier-service/check/id = {id}

请求参数:

参数 类型 描述
id int 已验证的邮件列表ID 要求

请注意,这些方法应该成对使用:首先,您需要使用核实邮寄名单方法,然后是“获取邮件列表验证结果”。否则,您将收到一个错误。

如果请求成功,您将收到一个响应:

{"id": 89163337, "address_book_name": "邮寄列表1","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": "Green", "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": "example3@gmail.com", "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. 无效的地址

获取经过验证的邮件列表列表

要获取经过验证的邮件列表列表,请向URL发送get请求:

https://api.半岛客户端下载官网www.ekobsc.com/verifier-service/check-list

请求参数:

参数 类型 描述
开始 int 从哪个记录显示结果;默认是0 可选
int 记录数;默认是10 可选

如果请求成功,您将收到一个响应:

{"total": 2, //已验证邮件列表个数"list": [{"id": 89114118, "address_book_name": "邮件列表1","all_emails_quantity": 0, "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": "Green", "is_garbage_in_book": false // true邮件列表包含先前验证的地址,false邮件列表未检查},{"id": 89163340, "address_book_name": "邮件列表2","all_emails_quantity": 0, "status": 1, "check_date": "2020-11-19 13:43:11", "data": {"0":0, //未验证地址个数(灰色)"1": 2, //有效地址个数(绿色)“2”:1,//未确认地址个数(黄色)"3": 0 //无效地址数(红色)},"is_updated": 1, // 1 -经过验证的新地址被添加到邮件列表中,0 -未经验证的邮件列表"status_text": "绿色,已更新","is_garbage_in_book": true // true邮件列表包含先前验证的地址,false邮件列表没有检查}]}

可能的邮件列表状态:

代码 名字 描述
1 绿色 邮件列表可能包含一小部分无效和未经确认的地址。一般来说,这样的列表被认为是“好的”,因为它不会导致许多交付错误。
2 黄色的 邮件列表包含一小部分无效地址和大量未经确认的地址。
3. 红色的 邮件列表中无效地址的比例很高

验证单个邮件地址

要验证一个电子邮件地址,发送POST请求到:

https://api.半岛客户端下载官网www.ekobsc.com/verifier-service/send-single-to-verify/

请求参数:

参数 类型 描述
电子邮件 字符串 需要验证的电子邮件地址 要求

请求示例:

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

如果请求成功,您将收到一个响应:

{"result": true}

要查看验证结果,请使用获取邮箱地址验证结果”的方法。

获取邮箱地址验证结果

要获取验证的结果,发送一个get请求到:

https://api.半岛客户端下载官网www.ekobsc.com/verifier-service/get-single-result/?电子邮件= {email}

请求参数:

参数 类型 描述
电子邮件 字符串 您验证的电子邮件地址 要求

请注意,这些方法应该成对使用:首先,您需要使用验证单个邮件地址方法,然后是“获取电子邮件地址验证结果”。否则,您将收到一个错误。

如果请求成功,您将收到一个响应:

{"result": true, "data": {"email": "example1@gmail.com", "checks": {"status": 1, "valid_format": 1, //如果地址格式正确,即包含正确顺序的有效字符"disposable": 0, //如果地址是由一次性邮件服务提供的"webmail": 0, //如果地址是由电子邮件服务提供的"gibberish": 0, //如果地址是自动生成的"status_text": "valid address"}}

创建邮件列表验证报告

要创建包含给定邮件列表验证结果的报告,请发送POST请求到:

https://api.半岛客户端下载官网www.ekobsc.com/verifier-service/make-report

请求参数:

参数 类型 描述
id int 已验证的邮件列表ID 要求
格式 int 报表格式,可以取值:2csv,3.——xls,4——xlsx;默认是2 可选
状态 数组 JSON_encoded数组,地址在报告中将有以下状态:0未经证实的,1——有效,2未经证实的,3.——无效;默认是[1] 可选
字符串 报告语言 可选

请求示例:

{" id ": 89165888,“格式”:2,“状态”:“(1、2、3)”,“朗”:“俄罗斯”}

如果请求成功,您将收到一个响应:

{"result": true}

查看邮件列表验证报告

要查看包含邮件列表验证结果的报告,请向以下地址发送GET请求:

https://api.半岛客户端下载官网www.ekobsc.com/verifier-service/check-reportid = {id}

请求参数:

参数 类型 描述
id int 为其创建报告的邮件列表ID 要求
格式 int 报表格式,可以取值:2csv,3.——xls,4——xlsx;默认是2 可选

请注意,这些方法应按顺序使用:首先需要使用创建邮件列表验证报告方法,然后是“查看邮件列表验证报告”和“下载邮件列表验证报告,否则,您将收到一个错误。

如果请求成功,您将收到一个响应:

{"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": 0, "3": 1}, "is_updated": 0, // 1-经过验证的邮件列表"status_text": "Red", "email_addresses": [{"id": 10422192143, "email_address": "user@example.com", "check_date": "2020-11-23 18:01:35", "status": 3, "status_text": "无效地址"},{"id":: "无效地址"},{"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}

下载邮件列表验证报告

要下载包含邮件列表验证结果的报告,请向以下地址发送GET请求:

https://api.半岛客户端下载官网www.ekobsc.com/verifier-service/get-reportid = {id}

请求参数:

参数 类型 描述
id int 为其创建报告的邮件列表 要求
格式 int 报表格式,可以取值:2csv,3.——xls,4——xlsx;默认是2 可选

如果请求成功,您将以选定的格式收到地址列表和每个地址的验证状态。

请注意,报告下载后,将从数据库中删除。如果您再次尝试获取报告,您将收到一个响应。

Baidu
map