大量电邮服务API
邮件列表
使用我们的API,您可以创建、编辑和删除邮件列表,以及对可用列表执行其他操作。
创建邮件列表
要创建一个邮件列表,发送一个POST请求到:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks |
请求参数:
参数 | 类型 | 描述 | |
bookName | 字符串 | 邮件列表名称 | 要求 |
请求示例:
{"bookName": "我的新书"}
如果请求成功,您将收到回复:
{"id":422325}
反应参数:
参数 | 类型 | 描述 |
id | int | 邮件列表ID |
编辑邮件列表
要编辑邮件列表,发送PUT请求到:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} |
请求参数:
参数 | 类型 | 描述 | |
id | int | 邮件列表ID | 要求 |
的名字 | 字符串 | 邮件列表新名称 | 要求 |
请求示例:
{"name": "新名称"}
如果请求成功,您将收到回复:
{"result": true}
获取邮件列表
要获得已创建的所有邮件列表的列表,向以下地址发送get请求:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks |
请求参数:
参数 | 类型 | 描述 | |
限制 | int | 记录数量 | 可选 |
抵消 | int | 偏移量(要显示的第一条记录) | 可选 |
当使用可选参数时,形成如下类型的URL:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks?limit=10&offset=5 |
如果请求成功,您将收到回复:
[{"id":1, "name":"我的第一本书","all_email_qty":1, "active_email_qty":0, "inactive_email_qty":1, "new_phones_quantity": 0, " active_phail_quantity ":0, " exc_phail_quantity ":0, "creationdate":"2015-04-20 08:52:40", "status":0, "status_explain":"Active"}, {"id":2, "name":"我的第二本书","all_email_qty":6, "active_email_qty":0, "inactive_email_qty":6, " new_phail_quantity ":0, " active_phail_quantity ":0, "exc_phones_quantity": 0:" ex_phones_quantity ":0:"0, "creationdate":"2015-04-20 09:02:39", "status":0, "status_explain":"Active"}]
反应参数:
参数 | 类型 | 描述 |
id | int | 邮件列表ID |
的名字 | 字符串 | 邮件列表名称 |
all_email_qty | int | 邮件总数 |
active_email_qty | int | 活动邮件数量 |
inactive_email_qty | int | 未激活邮件数量 |
new_phones_quantity | int | 新增电话号码个数 |
active_phones_quantity | int | 活跃的电话号码数 |
exc_phones_quantity | int | 未激活的电话号码数 |
创建日期 | 字符串 | 邮件列表创建日期 |
状态 | int | 状态码 |
status_explain | 字符串 | 状态的解释 |
可能的邮件列表状态:
状态码 | 状态描述 |
0 | 活动邮件列表 |
1 | 邮件列表标记为“已删除” |
3. | 等待用户对主持人澄清问题的回复 |
4 | 邮件列表被服务阻止 |
5 | 邮件列表被阻塞的守护程序转移电子邮件地址到一个活动;一旦解除阻塞,状态将变为«0» |
获取邮件列表信息
要获得关于特定邮件列表的详细信息,请将get请求发送到:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} |
请求参数:
参数 | 类型 | 描述 | |
id | int | 邮件列表ID | 要求 |
如果请求成功,您将收到回复:
[{"id":1, "name":"My first book", "all_email_qty":1, "active_email_qty":0, "inactive_email_qty":1, "active_phones_quantity": 0, "exc_phones_quantity": 0, "creationdate":"2015-04-20 08:52:40", "status":0, "status_explain":"Active"}]
反应参数:
参数 | 类型 | 描述 |
id | int | 邮件列表ID |
的名字 | 字符串 | 邮件列表名称 |
all_email_qty | int | 邮件总数 |
active_email_qty | int | 活动邮件数量 |
inactive_email_qty | int | 未激活邮件数量 |
active_phones_quantity | int | 活跃的电话号码数 |
exc_phones_quantity | int | 未激活的电话号码数 |
创建日期 | 字符串 | 创建日期 |
状态 | int | 状态码 |
status_explain | 字符串 | 状态的解释 |
获取邮件列表的变量列表
要获得邮件列表中可用的变量列表,向以下地址发送get请求:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} /变量 |
请求参数:
参数 | 类型 | 描述 | |
id | int | 邮件列表ID | 要求 |
如果请求成功,您将收到回复:
[{“名称”:“电子邮件”、“类型”:“字符串”},{“名称”:“名字”,“类型”:“字符串”},{“名称”:“日期”、“类型”:“日期”},{“名称”:“代码”,“类型”:“数量”}]
反应参数:
参数 | 类型 | 描述 |
的名字 | 字符串 | 变量名 |
类型 | 字符串 | 变量类型 |
从邮件列表中获取电子邮件列表
要从邮件列表中获取电子邮件列表,请发送get请求到:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} /电子邮件 |
请求参数:
参数 | 类型 | 描述 | |
id | int | 邮件列表ID | 要求 |
限制 | int | 记录数量 | 可选 |
抵消 | int | 偏移量(要显示的第一个记录) | 可选 |
活跃的 | 布尔 | 使用此参数可获得状态为“活动”和“新”的联系人列表 | 可选 |
not_active | 布尔 | 的列表活动联系人.了解更多”电子邮件状态及其描述” | 可选 |
方法返回最多100条记录限制
而且抵消
参数来抵消结果。
使用可选参数时,请按以下格式输入URL:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} /邮件?限制= 10抵消= 5 |
如果请求成功,您将收到回复:
[{“电子邮件”:“test@test.com”,“状态”:0,“status_explain”:“新”,“变量”:{“名称”:“约翰”,“国家”:“英国 " } }, { " 电子邮件”:“test2@test.com”、“地位”:0,”status_explain”:“新”、“变量”:{“名称”:“迈克尔”,“国家”:“英国”}})
反应参数:
参数 | 类型 | 描述 |
电子邮件 | 字符串 | 电子邮件地址 |
状态 | int | 邮箱状态 |
电话 | 字符串 | 电话号码 |
status_explain | 字符串 | 状态描述 |
变量 | 数组 | 变量列表,例如,{“variable_name”:“variable_value”} |
可能的邮件地址状态:
状态码 | 地位的名字 | 状态描述 |
0 | 新 | 新增地址;发送到此地址将被阻止,直到服务管理员激活它 |
1 | 活跃的 | 允许送货至本地址;如果地址未被激活,则发送被阻止 |
2 | 确认请求 | 已发送电子邮件给地址持有人确认订阅 |
3. | 激活请求 | 等待服务的管理员激活 |
4 | 没订阅 | 收件人未订阅此发件人发送的电子邮件 |
5 | 被管理员拒绝 | 被服务管理员拒绝 |
6 | 取消订阅所有时事通讯 | 由于收件人的投诉或收件人点击了«取消从此发件人的所有订阅»,电子邮件地址被服务管理员阻止 |
7 | 已请求激活 | 发送给收件人的激活电子邮件 |
8 | 阻塞 | 邮件地址被用户屏蔽 |
9 | 发送错误 | 无法将电子邮件发送到此地址(此状态表示发送错误) |
10 | 阻塞 | 邮件地址被主机列表屏蔽 |
11 | 阻塞 | 电子邮件地址被发件人的姓名屏蔽 |
12 | 阻塞 | 电子邮件地址被阻止的部分地址 |
13 | 用户删除 | 用户删除的邮箱地址 |
14 | 暂时不可用 | 邮件地址暂时不可用 |
获取邮件列表中的联系人总数
要获得邮件列表中的联系人总数,请发送get请求到:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} /电子邮件/总 |
请求参数:
参数 | 类型 | 描述 | |
id | int | 邮件列表ID | 要求 |
如果请求成功,您将收到回复:
{"total": 1}
反应参数:
参数 | 类型 | 描述 |
总计 | int | 邮件列表中的电子邮件地址总数 |
通过变量获取邮件列表中的所有联系人
通过变量查找邮件列表中的所有联系人,发送GET请求到:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} / /变量/ {variableName} / {searchValue} |
请求参数:
参数 | 类型 | 描述 | |
id | int | 邮件列表ID | 要求 |
variableName | 字符串 | 变量名 | 要求 |
searchValue | 字符串 | 变量值 | 要求 |
如果请求成功,您将收到回复:
[{"email": "a.kozlov@art-industria.ru", "status": 0, "status_explain": "New"}, {"email": "darkling@gmail.com", "status": 1, "status_explain": "Active"}]
反应参数:
参数 | 类型 | 描述 |
电子邮件 | 字符串 | 电子邮件地址 |
状态 | int | 邮件地址状态码 |
status_explain | 字符串 | 邮件地址状态说明 |
将电子邮件添加到邮件列表(单选入)
要将电子邮件添加到邮件列表,请向以下地址发送POST请求:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} /电子邮件 |
请求参数:
参数 | 类型 | 描述 | ||||
id | int | 邮件列表ID | 要求 | |||
电子邮件 | 数组 | 例如,序列化的电子邮件数组(“example@gmail.com”、“example@outlook.com”) ).如果需要添加带有变量的电子邮件,请使用以下结构: |
要求 | |||
电子邮件 | 字符串 | 订阅者电邮地址 | 要求 | |||
变量 | 数组 | 序列化的变量数组,例如, 可以在变量名中使用以下字符:所有Unicode字母字符(regex元组); 要添加电话号码,请使用system变量 |
要求 |
不带变量的请求示例:
{"email ":["test1@test.com", "test2@test.com"]}
带有变量的请求示例:
添加带有变量的联系人时,电子邮件应该只在相应的键下,如下例所示。
{“邮件”:[{“电子邮件”:“test@test.com”、“变量”:{“名称”:“伊丽莎白”、“电话”:“380632727700 " } }, { " 电子邮件”:“test2@test.com”}]}
如果请求成功,您将收到回复:
{"result": true}
将电子邮件添加到邮件列表(双重选择)
要对收件人使用双重选择(DOI)激活,请在请求中添加一个新参数:确认=力
.这将需要另一个参数:sender_email
-提供发件人的电邮地址作为其值;
发件人的电子邮件地址必须在SendPulse帐户中激活开云体育手机网页版登录入口官网设置.
请求参数:
参数 | 类型 | 描述 | ||||
id | int | 邮件列表ID | 要求 | |||
电子邮件 | 数组 | 例如,电子邮件地址的序列化数组(“example@gmail.com”、“example@outlook.com”) .如果需要添加带有变量的电子邮件,请使用以下结构: |
要求 | |||
电子邮件 | 字符串 | 订阅者电邮地址 | 要求 | |||
变量 | 数组 | 序列化的变量数组,例如,{"变量名":"变量值"} |
要求 | |||
确认 | 字符串 | 力 |
要求 | |||
sender_email | 字符串 | 寄件人电邮地址 | 要求 | |||
template_id | 字符串 | 确认邮箱ID;中创建服务设置(如果不指定参数,则发送默认邮件);例如,a3e45169 - 7 - ae7 4 - a39 b457 - 72 fd04401f26 |
可选 | |||
message_lang | 字符串 | 确认邮件的语言。它可以“en” ,“俄罗斯” ,“ua” ,“tr” ,“西文” ,“pt” 值 |
要求 |
请求示例:
{"email": [{"email":"test@gmail.com", "variables":{"name":"Alona"}}], "confirmation":"force", "sender_email":"sender@sendpul开云体育手机网页版登录入口官网se.com", "template_id":"a3e45169-7ae7-4a39-b457-72fd04401f2l", "message_lang":"en"}
如果请求成功,您将收到回复:
{"result": true}
从邮件列表中删除邮件
要从邮件列表中删除电子邮件,向以下地址发送delete请求:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} /电子邮件 |
请求参数:
参数 | 类型 | 描述 | |
id | int | 邮件列表ID | 要求 |
电子邮件 | 数组 | 序列化的电子邮件数组。您最多可以指定100个电子邮件地址删除在一个请求。 | 要求 |
请求示例:
{“邮件”:[“test1@test.com”、“test2@test.com”、“test3@test.com”]}
如果请求成功,您将收到回复:
{"result": true}
删除邮件列表
要删除邮件列表,向以下地址发送delete请求:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} |
请求参数:
参数 | 类型 | 描述 | |
id | int | 邮件列表ID | 要求 |
如果请求成功,您将收到回复:
{"result": true}
通过邮件列表获取活动的成本
要计算通过邮件列表进行的活动的成本,请发送GET请求到:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} /成本 |
请求参数:
参数 | 类型 | 描述 | |
id | int | 邮件列表ID | 要求 |
如果请求成功,您将收到回复:
{"cur": "USD", "sent_emails_qty": 16, "overdraftAllEmailsPrice": 0, "addressesDeltaFromBalance": 0, "addressesDeltaFromTariff": 16, "max_emails_per_task": 500, "result": true}
反应参数:
参数 | 类型 | 描述 |
坏蛋 | 字符串 | 用于计算的货币 |
sent_emails_qty | int | 电子邮件地址总数 |
overdraftAllEmailsPrice | int | 超出电子邮件地址限制的价格 |
addressesDeltaFromBalance | int | 将收取用户余额的电子邮件地址数目 |
addressesDeltaFromTariff | int | 按关税收费的电子邮件地址数目 |
max_emails_per_task | int | 电子邮件地址关税限制 |
结果 | 布尔 | 决定是否有足够的资金(真正的 或假 ) |
活动
创建一个活动
要创建一个电子邮件活动,发送一个POST请求到:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/campaigns |
请注意,你可以发送每小时最多4个战役。
请求参数:
参数 | 类型 | 描述 | ||||
sender_name | 字符串 | 发送者的名字 | 要求 | |||
sender_email | 字符串 | 寄件人电邮地址 | 要求 | |||
主题 | 字符串 | 邮件主题 | 要求 | |||
身体1 | 字符串 | 模板的HTML代码,以Base64编码 | 要求 | |||
template_id1 | int /字符串 | 在服务中上传或创建的模板ID。使用“获取所有模板的列表方法来获取模板IDreal_id 或id 参数) |
要求 | |||
list_id2 | int /数组 | 邮件列表ID或邮件列表ID数组(例如, 如果您发送一个测试活动与 |
要求 | |||
segment_id2 | int | 在您的帐户中创建的段ID([邮件列表]->选择邮件列表->[段]>[我的段]->选择段->从地址栏中的URL复制段ID) | 要求 | |||
is_test | 布尔 | 用于将测试电子邮件发送到指定的发件人地址sender_email 参数 |
可选 | |||
send_date | 字符串 | 邮件活动日期(可选参数),格式如下:Y-m-d H:i:s(例如:2016-02-02 23:34:23 ),且不能小于当前日期和时间 |
可选 | |||
的名字 | 字符串 | 活动名称 | 可选 | |||
use_dynamic_list | 布尔 | 用于发送到一个动态列表为预定的电子邮件征信。动态列表包括在创建广告系列之后、但在发送广告系列之前添加到邮件列表的联系人。适用于任何付费定价计划。 | 可选 | |||
附件 | 数组 | 附加文件,你最多可以添加5项其中键是附件的名称,值是附件的内容{" name1。扩展名:“content_1_file”,“name2”。扩展":" content_2_file "} |
可选 | |||
attachments_binary | 数组 | 附加文件,你最多可以添加5项其中键是附件的名称,值是附件的内容{" name1。扩展名:"base64_content_1_file", "name2. "扩展":" base64_content_2_file "} |
可选 | |||
类型 | 字符串 | 可能值-草案 [战役将以草稿形式创建] |
可选 | |||
body_amp3. | 字符串 | 电子邮件的AMP版本,以base64编码 | 可选 | |||
统计数据 | 对象 |
用于收集电子邮件打开和链接点击的统计信息 |
可选 | |||
点击 |
保龄球 |
点击链接。默认情况下- 真正的
|
可选 |
|||
打开 |
保龄球 | 活动开启。默认情况下-真正的 |
可选 | |||
utm_campaign | 字符串 | 在您的谷歌Analytics和Yandex活动的所有链接中添加自定义UTM标签。Metrica | 可选 |
1.方法可在请求中直接发送模板以指定电子邮件的正文身体
参数,或使用在服务中创建的模板template_id
参数。这两个参数之一是必需的。
2.要指定收件人列表,可以使用list_id
或segment_id
参数,两个参数之一是必需的。
3.AMP体码必须是有效的,需要谷歌和mail.ru的确认才能使用。你可透过“服务设置.”
使用模板创建活动的请求示例:
{"sender_name":"my_sender_name", "sender_email":"my_sender@test.com", "subject":"hello customer", "list_id":"756589", "name":"my_api_campaign", "template_id": "775667"}
向动态列表创建计划活动的请求示例:
{"sender_name":"API_TEST", "sender_email":"my_sender@test.com", "subject":"API campaign", "list_id":"756589", "name":" API campaign", "body": "SmFja2llIENoYW4=", "send_date":"2016-02-02 23:34:23", "use_dynamic_list": true}
创建草稿的请求示例:
{"sender_name":"my_sender_name", "sender_email":"my_sender@test.com", "subject":"hello customer", "list_id":"756589", "name":"my_api_campaign", "body": "bXkgYXBpIGJvZHk=", "type":"draft"}
请求创建带有附件的广告系列的示例:
{"sender_name":"my_sender_name", "sender_email":"my_sender@test.com", "subject":"hello customer", "list_id":"756589", "name":"my_api_campaign", "body": "bXkgYXBpIGJvZHk=", "attachments":{"text.txt":"my content file"}}
请求创建带有附件的广告系列的示例(attachments_binary):
{"sender_name":"my_sender_name", "sender_email":"my_sender@test.com", "subject":"hello customer", "list_id":"756589", "name":"my_api_campaign", "body": "bXkgYXBpIGJvZHk=", "attachments_binary":{"text.txt":"bXkgY29udGVudCBmaWxlIGluIGJhc2U2NA=="}}
创建带有自定义收集统计选项的活动的请求示例:
{"sender_name":"my_sender_name", "sender_email":"my_sender_email@test.com", "subject":"API campaign", "list_id":"89286777", "name":"My campaign", "body": "SmFja2llIENoYW4=", "stats":{" opening ":true, //启用收集打开统计"clicks":false, //禁用收集点击统计"utm_campaign":"MY_UTM"}}
如果请求成功,您将收到回复:
{"id": 245587, "status": 13, "count": 1, "tariff_email_qty": 1, "overdraft_price": "0.0044", " overdraft_currency ": "RUR"}
反应参数:
参数 | 类型 | 描述 |
id | int | 电子邮件活动ID |
状态 | int | 发送任务状态(13 -复制发送地址,26 -起草) |
数 | int | 活动发送给的收件人数量 |
tariff_email_qty | int | 从用户余额中注销的电子邮件数 |
overdraft_price | 字符串 | 价格为一个电子邮件在增加 |
ovedraft_currency | 字符串 | 货币 |
编辑计划活动
要编辑预定的活动,请发送PATCH请求到:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/campaigns/ {id} |
请求参数:
参数 | 类型 | 描述 | |
id | int | 电子邮件活动ID | 要求 |
的名字 | 字符串 | 电子邮件活动名称 | 要求 |
sender_name | 字符串 | 发送者的名字 | 要求 |
sender_email | 字符串 | 寄件人电邮地址 | 要求 |
主题 | 字符串 | 邮件主题 | 要求 |
身体 | 字符串 | 模板的HTML代码,以base64编码 | 要求 |
template_id | int /字符串 | 在服务中上传的模板ID。使用“获取一个帐户上所有模板的列表方法来获取模板IDreal_id 或id 参数) |
要求 |
send_date | 字符串 | 预定的电子邮件活动日期(可选参数)。必须符合以下格式:Y-m-d H:我:s (例如,2016-02-02 23:34:23 ),且不能小于当前日期和时间 |
可选 |
请求示例:
{"name":"my_api_campaign", "sender_name":"Sender", "sender_email":"sender@gmail.com", "subject":"Hello customer", "template_id":123348, "send_date":"2021-07-06 11:45:00"}
如果请求成功,您将收到回复:
{"result": true, "id": 470791}
获取活动信息
要获取活动信息,请发送get请求到:
https://api.开云体育手机网页版登录入口官网www.alanlshields.com/campaigns/ {id} |
请求参数:
参数 | 类型 | 描述 | |
id | int | 电子邮件活动ID | 要求 |
如果请求成功,您将收到回复:
{"id": 14973974, "name": "test check link", "is_sms": false, "is_viber": false, "message": {"sender_name": "test", "sender_email": "e.b@se开云体育手机网页版登录入口官网ndpulse.com", "subject": "test check link", "body": " < html >…