大量电邮服务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_idid参数) 要求
list_id2 int /数组

邮件列表ID或邮件列表ID数组(例如,(88891852, 88891852)).您最多可以添加10个邮件列表。

如果您发送一个测试活动与is_test参数或分段活动segment_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_idsegment_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_idid参数) 要求
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 >…", "preheader": "", "attachments": "", "list_id": 893开云体育备用网址11111}, "external_stat": {"check_open_email": true, "check_redirect_link": true}, "status": 3, "all_email_qty": 2, "tariff_email_qty": 2, "paid_email_qty": 0, "overdraft_price": 0, "company_price": "0.05", "overdraft_currency": "UAH", "send_date": "2021-09-01 10:55:39", "permalink": "http://archive.sen开云体育手机网页版登录入口官网dpulse.com//u/NzA0MzY2sdghM34w==/8wxdgwz43q/", "statistics": {"general": [{"code": 0, "count": 0, "explain":"在队列中"},{"code": 1, "count": 2, "explain": "已发送"},{"code": 2, "explain": "已发送"},{"code": 3, "count": 2, "explain": "已打开"},{"code": 4, "count": 2, "explain": "链接重定向"},{"code": 5, "count": 0, "explain": "用户取消订阅"},{"code": 6, "count": 0, "explain": "邮件服务器应答::无此类邮件"},{"code": 7, "count": 0, "explain": "暂时不可用(稍后会发送)"“代码”},{:8,“数”:0,“解释”:“不可用”},{“代码”:9,“数”:0,“解释”:“邮件服务器回答::垃圾邮件被服务器拒绝”},{“代码”:10,“数”:0,“解释”:“邮件服务器的答案::邮箱已满”},{“代码”:11,“数”:0,“解释”:“邮件服务器回答::标记为垃圾邮件的用户”},{“代码”:12,“数”:0,“解释”:“交付失败”},{“代码”:13日,“数”:0,“解释”:“不发送”},{“计数”:“代码”:14日0时,“解释”:“不这样的域”},{“代码”:15, "count": 0, "explain": "Unsubscribe from newsletter"}, {"code": 16, "count": 0, "explain": "Not valid email"}, {"code": 17, "count": 0, "explain": "Temporary blocked"}, {"code": 18, "count": 0, "explain": "被管理员禁用"},{"code": 20, "count": 0, "explain": "Already Unsubscribe "}], "clicks": [{"url": "https://s7043663.sendpul "。se/views/ru/{{CampaignId}}/{{EmailCode}}/h/e5203e703e95d001c286990chdfh45fc87ee", "count": 0}, {"url": "https://habr.com/ru/all/", "count": 3}, {"url": "" ", "count": 0}, {"url": "https://send开云体育手机网页版登录入口官网pulse.com/ru/email-powered-by-sendpulse?sn=d3BsgjksfsfhadGVzdA%3D%3D&from=70474573563663", "count": 0}]}}

可能的活动状态:

状态码 状态描述
0
1 待定(适度)
2 发送中
3. 发送
4 测试活动(发送到用户邮箱)
5 活动被阻止(服务)
6 该活动被标记为要删除
7 状态更新(状态«3»将紧随其后)
8 测试活动已发送
9 正在交付
10 正在处理发送的活动
11 等待用户对主持人查询的响应
12 没有活动地址
13 活动创建正在进行中-电子邮件从邮件列表转移到活动中。如果列表上的电子邮件少于20封,状态«2»将紧随其后;否则,代码«1»将紧随其后。
14 活动创建并发送到队列。当发送所有消息时,状态«3»将紧随其后。
15 战役等待A/B测试结果
16 活动被用户取消
22 发送部分
23 发送部分
25 活动部分发送和阻止服务管理员
26 草案
27 需要编辑
28 计划将邮件重发至未读状态
33 自动化。资产超过
36 自动化草案

获取活动列表

要获得活动列表,请发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/campaigns

请求参数:

参数 类型 描述
限制 int 记录数量 可选
抵消 int 偏移量(要显示的第一个记录) 可选
订单 字符串 参数,asc-从高到低,desc-从低到高 可选
状态 数组 电子邮件活动状态列表(int) 可选
策划 布尔 允许您返回预定活动的参数 可选

当使用可选参数时,形成如下类型的URL:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/campaigns?order=desc&status[] = 3计划= 1限制= 100抵消= 10

如果请求成功,您将收到回复:

[{"id": 14911开云体育备用网址111, "name": "test check link", "status": 3, "is_sms": false, "is_viber": false, "send_date": "2021-09-01 10:55:39", "all_email_qty": 2, "tariff_email_qty": 2, "paid_email_qty": 0, "overdraft_price": 0, "company_price": "0.05", "overdraft_currency": "UAH", "message": {"sender_name": "test", "sender_email": "e.b@sen开云体育手机网页版登录入口官网dpulse.com", "subject": "test check link", "attachments": "" list_id": 89311111}, "statistics": {"sent": 2, "delivered": 2, "opening": 2, "link_redirect ":2, "unsubscribe": 0, "error": 0}}]

反应参数:

参数 类型 描述
id int 电子邮件活动ID
的名字 字符串 电子邮件活动名称
is_sms 布尔 参数,该参数确定此活动是否为SMS活动
is_viber 布尔 参数,该参数确定此活动是否是Viber活动
send_date 字符串 活动发送日期
company_price 字符串 活动价格
sender_name 字符串 发送者的名字
sender_email 字符串 寄件人电邮地址
主题 字符串 邮件主题
身体 字符串 邮件正文
list_id int 邮件列表ID
附件 字符串 附件
状态 int 电子邮件活动状态码
all_email_qty int 电子邮件地址总数
tariff_email_qty int 注销用户余额的电子邮件数
paid_email_qty int 从超出关税限额的余额中支付的电子邮件地址数目
overdraft_price int 如果超过,每封信价格
overdraft_currency 字符串 货币
发送 int 发送消息总数
交付 int 传递的消息总数
开放 int 已打开邮件总数
link_redirected int 链路重定向的个数
退订 int 未订阅用户总数
错误 int 错误的数量

获取使用特定邮件列表创建的活动列表

要获得使用特定邮件列表创建的活动列表,请向以下地址发送get请求:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} /活动

请求参数:

参数 类型 描述
id int 邮件列表ID 要求
限制 int 记录数量 可选
抵消 int 偏移量(要显示的第一个记录) 可选

如果请求成功,您将收到回复:

[{"task_id": 9147593, "task_name": "Test", "task_status": 3}, {"task_id": 9156095, "task_name": "Campaign_6741804_UM99", "task_status": 3}]

反应参数:

参数 类型 描述
task_id int 电子邮件活动ID
task_name 字符串 电子邮件活动名称
tast_status int 电子邮件活动状态码

获取国家统计数据

要获得一个国家的统计数据,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/campaigns/ {id} /国家

请求参数:

参数 类型 描述
id int 电子邮件活动ID 要求

如果请求成功,您将收到回复:

{" us ": 23, " ua ": 34567}

反应参数:

参数 类型 描述
我们(UA) int 邮件打开

获取推荐统计数据

要获得推荐统计数据,发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/campaigns/ {id} /推荐

请求参数:

参数 类型 描述
id int 电子邮件活动ID 要求

如果请求成功,您将收到回复:

[{“链接”:“http://first_link.com”“数”:123454},{“链接”:“http://second_link.com”“数”:5463}]

反应参数:

参数 类型 描述
链接 字符串 来自电子邮件的URL
int 链接点击次数

取消活动

要取消活动,发送DELETE请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/campaigns/ {id}

请求参数:

参数 类型 描述
id int 电子邮件活动ID 要求

如果请求成功,您将收到回复:

{"result": true}

模板

创建模板

要创建一个模板,发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/template

请求参数:

参数 类型 描述
的名字 字符串 模板名称(该参数为可选参数,如果不指定,则显示为模板YYYY.mm.dd H:i:s 要求
身体 字符串 HTML版本的电子邮件,以base64编码 要求
字符串 模板语言,可以带“俄罗斯””,在““ua”“tr”“西文”“pt” 要求

请求示例:

{"name": "My Template", "body": "PGlucHV0IHR5cGU9ImVtYWlsIiBuYW1lPSJlbWFpbCIgcmVxdWlyZWQKb25pbnZhbGlkPSJ0aGlzLnNldEN1c3RvbVZhbGlkaXR5KCfQn9C+0LbQsNC70YPQudGB0YLQsCwg0L3QsNC/ 0ljrinc40ylqtsblbwfpbcdqu9cw0ylqunc90yhqutc40lzqucdqsdgd0lzquccpiibvbmluchv0psjzzxrddxn0b21wywxpzgl0esgnjykiic8 +", "lang": "ru"}

如果请求成功,您将收到回复:

{"result": true, "real_id": 1042220}

反应参数:

参数 类型 描述
real_id int 已创建模板ID

编辑模板

要编辑模板,发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/template/edit/ {id}

请求参数:

参数 类型 描述
id int /字符串 在服务中上传的模板ID。使用“获取一个帐户上所有模板的列表方法来获取模板IDreal_idid参数) 要求
身体 字符串 HTML版本的电子邮件,以base64编码 要求
字符串 模板语言 可选

请注意模板语言必须是在创建此模板期间指定的。

请求示例:

{"body": "PGlucHV0IHR5cGU9ImVtYWlsIiBuYW1lPSJlbWFpbCIgcmVxdWlyZWQKb25pbnZhbGlkPSJ0aGlzLnNldEN1c3RvbVZhbGlkaXR5KCfQn9C+0LbQsNC70YPQudGB0YLQsCwg0L3QsNC/0LjRiNC40YLQtSBlbWFpbCDQu9Cw0YLQuNC90YHQutC40LzQuCDQsdGD0LrQstCw0LzQuCcpIiBvbmlucHV0PSJzZXRDdXN0b21WYWxpZGl0eSgnJykiIC8+", "lang": "ru"}

如果请求成功,您将收到回复:

{"result": true}

获取模板信息

要获取关于模板的信息,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/template/ {template_id}

请求参数:

参数 类型 描述
template_id int /字符串 在服务中上传的模板ID。使用“获取一个帐户上所有模板的列表方法来获取模板IDreal_idid参数) 要求

如果请求成功,您将收到回复:

{"id":"f3266876955c9d21e214deed49b97446", "real_id":1153018, "lang":"en", "name":"网络研讨会发言人","name_slug":"" "created":"2020-09-04 13:54:30", "full_description":"请使用此模板作为网络研讨会邀请。明确谁将主持本次网络研讨会以及会议内容。记住要包括会议的日期和时间。","is_structure":true, "category":"education", "category_info":{"id":109, "name":" education", "meta_description":"这些"education"免费电子邮件模板是由SendPulse为所有那些希望使他们的电子邮件交流丰富多彩和难忘的人开发的。开云体育手机网页版登录入口官网您可以使用这些模板在SendPulse中创建您的电子邮件活动。","full_description":"", "code"开云体育手机网页版登录入口官网:"education", "sort":6}, "tags":{"webinar":"webinar", "study":"study", "marketing":"marketing", "muse开云体育重庆时时彩um":"museum", "exhibition":"exhibition"}, "owner":" SendPulse ", "preview":"https://login.www.alanlshields.com/files/emailservice/userfiles/templates/preview/f3266876955c9d21e214deed49b97446_thumbnail_300.png"}

获取一个帐户的模板列表

要获得一个帐户的模板列表,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/templates

如果请求成功,您将收到回复:

[{"id":"c7a94d4f8395ae5a4183423309d5e99b", //请注意,每次编辑模板"real_id":775667, "lang":"en", "name":" 11月。9, 2018 08:24:10”,“name_slug”:“nov-9-2018-08-24-10”,“created”:“2018-11-09 05:24:10”,“full_description”:null,“category”:“”,“category_info”:[],“tags”:[],“owner”:“you”,“preview”:“https://login.sendpulse.开云体育手机网页版登录入口官网com/files/emailservice/templates/preview/e52678826db12b069358f159fde800726741804/c7a94d4f8395ae5a4183423309d5e99b.png”},{“id”:“5979adc7712b8c822a28b486f9778a15”,“real_id”:508742,“lang”:“en”,“name”:“情人节:sweet", "name_slug":"sweet-valentines-day", "created":"2018-02-01 08:55:04", "full_description":"", "category":"holiday", "category_info":{"id":146, "name":" holiday", "meta_description":"这些"holiday"免费电子邮件模板由SendPulse开发。开云体育手机网页版登录入口官网祝贺你的客户、朋友或亲戚。使用这些模板在SendPulse中创建自己的电子邮件活动。","full_description":"", "cod开云体育手机网页版登录入口官网e":"holiday", "sort":2}, "tags":{"valentine":"valentine"}, "owner":" SendPulse ", "preview":"https://login.www.alanlshields.com/files/emailservice/templates/preview/5979adc7712b8c822a28b486f9778a15_thumbnail.png"}]

获取所有系统模板的列表

要获得所有系统模板的列表,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/templates/?owner=sendpulse

获取所有用户模板的列表

要获得所有用户模板的列表,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/templates/?owner=me

通过名称获取模板

要按名称获取模板,请发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/template/slug/ {name_slug}

请求参数:

参数 类型 描述
name_slug 字符串 模板的系统名称,您可以在API响应中通过其他参数创建或搜索模板 要求

获取一种特定语言的所有模板列表

要获得特定语言中所有模板的列表,请向以下地址发送get请求:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/templates/ru/?owner=me

发送方

获取所有发件人的列表

要获得所有发件人的列表,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/senders

如果请求成功,您将收到回复:

[{“名称”:“John Doe”、“电子邮件”:“JohnDoe@test.com”,“状态”:“活跃”},{“名称”:“John Doe”、“电子邮件”:“JaneDoe@test.com”,“状态”:“活跃”}]

添加发件人

要添加一个发件人,发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/senders

请求参数:

参数 类型 描述
电子邮件 字符串 寄件人电邮地址 要求
的名字 字符串 发送者的名字 要求

请求示例:

{"email": "sender@example.com", "name": "Sender"}

如果请求成功,您将收到回复:

{"result": true}

删除发件人

要删除一个发件人,发送一个delete请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/senders

请求参数:

参数 类型 描述
电子邮件 字符串 寄件人电邮地址 要求

请求示例:

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

如果请求成功,您将收到回复:

{"result": true}

激活发件人

激活一个发送者,发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/senders/ {email} /代码

请求参数:

参数 类型 描述
电子邮件 字符串 寄件人电邮地址 要求
代码 字符串 激活代码 要求

请求示例:

{"code": "50405325fdbb31e79759e7b8ae305ef75"}

如果请求成功,您将收到回复:

{"result": true, "email": JohnDoe@test.com}

获取发件人电子邮件地址的激活码

要获得发送者电子邮件地址的激活码,请发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/senders/ {email} /代码

请求参数:

参数 类型 描述
电子邮件 字符串 寄件人电邮地址 要求

如果请求成功,您将收到回复:

{"result": true, "email": JohnDoe@test.com}

如果请求成功,发送者将收到一封带有激活码的电子邮件。

电子邮件地址

获取关于特定电子邮件地址的一般信息

要获得关于特定电子邮件地址的一般信息,请发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/emails/ {email}

请求参数:

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

如果请求成功,您将收到回复:

[{“book_id”:154441年,“电子邮件”:“test@gmail.com”,“状态”:0,“status_explain”:“新”,“变量 ":[] }, { " book_id”:422325年,“电子邮件”:“test@gmail.com”、“状态”:1、“status_explain”:“活跃”、“变量”:[{" name ": "名称”、“类型”:“弦”、“价值”:“Alona”}]}]

获取特定电子邮件地址的详细信息

要获得关于特定电子邮件地址的详细信息,请发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/emails/ {email} /细节

请求参数:

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

如果请求成功,您将收到回复:

[{“list_name”:“test1”、“list_id”:1375516,“add_date”:“2017-11-21 11:45:41”、“源”:“面板”},{“list_name”:“test2”、“list_id”:1415158,“add_date”:“2018-01-23 07:07:08”、“源”:“面板”},{“list_name”:“订阅”,“list_id”:1649207,“add_date”:“2018-04-02 13:55:38”、“源”:“形式”}]

获取电子邮件地址列表的一般信息

要获得电子邮件地址列表的一般信息,请发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/emails

请求参数:

参数 类型 描述
电子邮件 数组 电子邮件地址列表 要求

请求示例:

{"电子邮件":[“test1@gmail.com”、“test2@gmail.com”]}

如果请求成功,您将收到回复:

{“test1@gmail.com”:[{“book_id”:154441年,“状态”:0,”变量 ":[] }, { " book_id”:422325年,“状态”:1、“变量”:[{" name ": "名称”、“类型”:“弦”、“价值”:”测试 " } ] } ], " test2@gmail.com”:[{“book_id”:422325年,“状态”:1、“变量”:[{“名称”:“名字”,“类型”:“弦”、“价值”:”测试 " } ] } ] }

从特定活动中获取特定电子邮件地址的信息

要获取特定电子邮件地址的信息,请发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/campaigns/ {id} /电子邮件/ {email}

请求参数:

参数 类型 描述
id int 电子邮件活动ID 要求
电子邮件 字符串 电子邮件地址 要求

如果请求成功,您将收到回复:

{"sent_date": "2021-03-29 07:46:58", "global_status": 1, "global_status_explain": "已发送","detail_status": 3, "detail_status_explain": "已打开"}

反应参数:

参数 类型 描述
send_date 字符串 发送电子邮件活动的日期
global_status int 全球电子邮件活动状态码
global_status_explain 字符串 全局状态描述
detail_status int 详细的电子邮件活动状态代码
detail_status_explain 字符串 详细状态描述

从邮件列表中获取电子邮件地址的信息

要从邮件列表中获取电子邮件地址的信息,请将get请求发送到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} /电子邮件/ {email}

请求参数:

参数 类型 描述
id int 邮件列表ID 要求
电子邮件 字符串 电子邮件地址 要求

如果请求成功,您将收到回复:

{“电子邮件”:“test@gmail.com”、“abook_id”:“422325”,“电话”:“”,“状态”:1、“status_explain”:“活跃”、“变量”:[{“名称”:“名字”,“类型”:“弦”、“价值”:“测试”}]}

反应参数:

参数 类型 描述
电子邮件 字符串 电子邮件地址
abook_id 字符串 邮件列表ID
电话 字符串 电话号码
状态 int 邮件地址状态码
status_explain 字符串 邮件地址状态说明
变量 数组 电子邮件的变量数组(等于[]如果联系人没有变量,或者变量为空):
的名字 字符串 变量名
类型 字符串 变量类型
价值 字符串 变量值

从所有邮件列表中删除电子邮件地址

要从所有邮件列表中删除一个电子邮件地址,发送一个delete请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/emails/ {email}

请求参数:

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

如果请求成功,您将收到回复:

{"result": true}

获取电子邮件地址和活动的统计数据

要获得电子邮件地址和活动的统计数据,请发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/emails/ {email} /活动

请求参数:

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

如果请求成功,您将收到回复:

{"statistic": {"sent": 9, "open": 2, "link": 0}, "blacklist": false, "addressbooks": [{"id": 154441, "address_book_name": "邮件列表1"},{"id": 154472, "address_book_name": "邮件列表2"}]}

获取统计数据的多个电子邮件地址和活动,他们在

要获得他们所在的多个电子邮件地址和活动的统计数据,请发送POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/emails/campaigns

请求参数:

参数 类型 描述
电子邮件 数组 电邮地址一览表 要求

请求示例:

{"email ": ["example@yourdomain.com", "example2@yourdomain.com"]}

如果请求成功,您将收到回复:

{“example@yourdomain.com”:{“开放”:“发送”:21日11日“链接”:3,“adressbooks”:[{" id ": 1375516,“名字”:“book1 "}, {" id ": 1415158,“名字”:“book3 "}, {" id ": 1649207,“名字”:“book10”}],“黑名单”:假},“example2@yourdomain.com”:{“发送”:1、“开放”:1、“链接”:0,“adressbooks”:[{" id ": 1734397,“名字”:“тест1 "}),“黑名单”:真正}}

更改电子邮件联系人的变量

要更改电子邮件的变量,请发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {addressBookId} /电子邮件/变量

请求参数:

参数 类型 描述
addressBookId int 邮件列表ID 要求
电子邮件 字符串 电子邮件联系地址 要求
变量 数组 变量列表,例如,{" name ": "名称”、“价值”:“约翰”} 要求

请求示例:

{“电子邮件”:“myemail@example.com”、“变量”:[{“名称”:“名字”,“价值”:“约翰”},{“名称”:“日期”、“价值”:“2019-02-01”}]}

如果请求成功,您将收到回复:

{"result": true}

每次请求只能更改一个电子邮件

的变量字符串输入accept数值或以以下格式表示日期的值:YYYY-MM-DD

的变量数量Type只接受数字。

变量的日期Type只接受以下格式的日期:YYYY-MM-DD.不支持其他格式。例:有效日期:2017-01-01,失效日期:2017-1-1

黑名单

在黑名单中获取联系人列表

要查看黑名单,向以下地址发送GET请求:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/blacklist

如果请求成功,您将收到回复:

["JohnDoe@test.com", "JaneDoe@test.com",]

将邮箱地址加入黑名单

要将一个电子邮件地址添加到黑名单,请发送POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/blacklist

请求参数:

参数 类型 描述
电子邮件 字符串 以逗号分隔的电子邮件地址,并以Base64编码 要求
评论 字符串 评论 可选

请求示例:

{"email ": "dXNlcjFAbWFpbHNlcnZlci5jb20sdXNlcjJAbWFpbHNlcnZlci5jb20sdXNlcjNAbWFpbHNlcnZlci5jb20=", "comment": "comment"}

如果请求成功,您将收到回复:

{"result": true}

从特定邮件列表中取消订阅联系人

若要从特定邮件列表中取消订阅联系人,请向以下地址发送POST请求:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/addressbooks/ {id} /电子邮件/退订

请求参数:

参数 类型 描述
id int 邮件列表ID 要求
电子邮件 数组 要从定义的邮件列表中取消订阅的电子邮件地址列表 要求

请求示例:

{"电子邮件":[“test1@gmail.com”、“test2@gmail.com”]}

如果请求成功,您将收到回复:

{"result": true}

从黑名单中删除邮件地址

若要从黑名单中删除邮件地址,请向以下地址发送delete请求:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/blacklist

请求参数:

参数 类型 描述
电子邮件 字符串 以逗号分隔并以base64编码的电子邮件地址列表 要求

电子邮件地址字符串的示例(在base64编码之前):

user1@mailserver.com, user2@mailserver.com, user3@mailserver.com

请求示例:

{"email ": " dxnlcjfabwfpbhnlcnzlci5jb20sdxnlcjjabwfpbhnlcnzlci5jb20sdxnlcjnabwfpbhnlcnzlci5jb20sdxnlcjnabwfpbhnlcnzlci5jb20 ="}

如果请求成功,您将收到回复:

{"result": true}

平衡

获取你的结余信息

要获得您的余额信息,请发送get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/balance

一个可选的请求参数——货币值。

使用可选参数时,URL格式如下:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/balance/USD

如果请求成功,您将收到回复:

{"currency": "USD", "balance_currency": 0.02}

获取详细的结余信息

要获得详细的余额信息,向以下地址发送get请求:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/user/balance/detail

如果请求成功,您将收到回复:

{"balance": {"main": "9.36", "bonus": "5.00", "currency": "USD"}, "email": {"tariff_name": "Pay as you go 10000 ", "finished_time": "2019-04-25 08:03:02", "emails_left": 9914, "maximum_subscribers": 10000, "current_subscribers": 0}, "smtp": {"tariff_name": "smtp Free", "end_date": "2018-11-21 15:05:39", "auto_renew": 1}, "push": {"tariff_name": "White Label", "end_date": "2018-11-30", "auto_renew": 1}}

人则

有关webhooks的更多信息,如何在您的个人SendPulse帐户中连接它们,以及接收到的事件webhooks格式的示例,请参阅文章“开云体育手机网页版登录入口官网如何在电子邮件服务中连接网络钩子.”

您还可以通过以下API方法创建、编辑和接收有关webhook的信息:

获得一个Webhooks列表

要获得webhook的列表,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/v2/email-service/webhook

如果请求成功,您将收到回复:

{“成功”:真的,“数据”:[{" id ": 162242年,“user_id”:7043663,“url”:“https://site.com/callback”、“行动”:“退订”},{" id ": 162241年,“user_id”:7043663,“url”:“https://site.com/callback, "action": "open"}]}

通过ID获取Webhook

通过ID获取一个webhook,发送一个get请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/v2/email-service/webhook/ {id}

请求参数:

参数 类型 描述
id int Webhook ID 要求

如果请求成功,您将收到回复:

{“成功”:真的,“数据”:{" id ": 162242年,“user_id”:7043663,“url”:“https://site.com/callback, "action": "unsubscribe"}}

创建一个Webhook

要创建一个webhook,发送一个POST请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/v2/email-service/webhook/

请求参数:

参数 类型 描述
行动 字符串或数组 例如,跟踪事件,(“开放”、“退订”) 要求
url 字符串 URL到处理程序,例如,https://site.com/callback 要求

操作的可能值:

行动 描述
new_emails 添加新的电子邮件地址
删除 邮件地址已从邮件列表中删除
退订 用户没订阅
task_status_update 活动状态更改
开放 活动开始了
交付 交付
重定向 下面的链接
垃圾邮件 用户被标记为垃圾邮件

数据以x-www-form-urlencoded类型发送。

请求示例:

{“url”:“https://site.com/callback”,“行动”(“交付”)}

如果请求成功,您将收到回复:

{“成功”:真的,“数据”:[{“user_id”:7043663,“url”:“https://site.com/callback”、“id”:162241年,“行动”:“开放”},{“user_id”:7043663,“url”:“https://site.com/callback", "id": 162242, "action": "unsubscribe"}]}

删除Webhook

要删除一个webhook,发送一个delete请求到:

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/v2/email-service/webhook/ {id}

请求参数:

参数 类型 描述
id int Webhook ID 要求

如果请求成功,您将收到回复:

{"success": true, "data": [true]}

更新Webhook

要更新webhook,发送PUT请求到::

https://api.开云体育手机网页版登录入口官网www.alanlshields.com/v2/email-service/webhook/ {id}

数据以x-www-form-urlencoded类型发送。

请求参数:

参数 类型 描述
id int Webhook ID 要求
url 字符串 指向处理程序的URL,例如,https://site.com/callback 要求

如果请求成功,您将收到回复:

{"success": true, "data": [true]}
-->
Baidu
map