Зарегистрироваться
Войти
Протокол интеграции HTTPs (REST) для рассылки E-mail сообщений
ВНИМАНИЕ
Для использования данного вида интеграции Вам необходимо зарегистрироваться на серверной платформе Stream Telecom, либо зарегистрироваться через менеджера компании.
Функции
Оглавление:
Получение списка базPOST
username=user&password=userpasswd&method=lists.get&list_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
id запрашиваемой базы. Обязательный. |
Ответ
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"id": "123",
"state": "active",
"import_result": "",
"name": "Test base",
"creation_date": "2017-03-06 13:25:36",
"merge_1": "a:4:{s:5:\"title\";s:6:\"Имя\";s:4:\"type\";s:4:\"text\";s:3:\"req\";N;s:3:\"var\";s:6:\"ИМЯ\";}",
"merge_2": "a:4:{s:5:\"title\";s:14:\"Фамилия\";s:4:\"type\";s:4:\"text\";s:3:\"req\";N;s:3:\"var\";s:14:\"ФАМИЛИЯ\";}",
"merge_3": "a:4:{s:5:\"title\";s:25:\"День рождения\";s:4:\"type\";s:4:\"date\";s:3:\"req\";N;s:3:\"var\";s:4:\"ДР\";}",
"merge_4": "a:4:{s:5:\"title\";s:14:\"Телефон\";s:4:\"type\";s:6:\"number\";s:3:\"req\";N;s:3:\"var\";s:14:\"ТЕЛЕФОН\";}",
"merge_5": "a:4:{s:5:\"title\";s:16:\"Отчество\";s:4:\"type\";s:4:\"text\";s:3:\"req\";N;s:3:\"var\";s:13:\"ШАБЛОН5\";}",
"merge_6": "",
"description": "",
"company": "",
"abuse_name": "Александр",
"abuse_email": "mail@mail.com",
"phone": "",
"address": "пр. Обуховской обороны 271 лит. А",
"city": "Санкт-Петербург",
"zip": "190000",
"country": "7",
"url": "",
"unsub": "0",
"eng": "0",
"redirect": "web.szk-info.ru ",
"sub_redirect": "https://stream-telecom.ru/ ",
"count": "a:6:{s:6:\"active\";s:2:\"10\";s:8:\"inactive\";s:1:\"2\";s:12:\"unsubscribed\";s:1:\"0\";s:7:\"bounced\";s:1:\"0\";s:3:\"all\";i:12;}",
"common_rate": "0",
"bounce_rate": "0",
"updated": "0",
"stat": "a:2:{s:9:\"open_rate\";s:5:\"88.89\";s:10:\"click_rate\";s:4:\"0.00\";}",
"stat_update_time": "2017-04-10 13:39:01",
"count_active": "10",
"count_all": "12",
"count_bounced": "0",
"count_unsubscribed": "0"}]}}
|
Параметр |
Описание |
|
id |
id адресной базы |
|
import_result |
результат импортирования базы (постой в данном методе) |
|
name |
название адресной базы |
|
creation_date |
дата создания базы |
|
merge_{1..10} |
сериализированные массивы настроек дополнительных полей: title - название дополнительного поля type - тип поля. возможные значения: text, number, date, choice req - обязательно поле или нет? возможные значения: on, N var - название шаблона |
|
description |
описание того, как подписчик может оказаться в этой базе |
|
company |
название вашей компании, владеющей адресной базой |
|
abuse_name |
имя человека, которому можно жаловаться на спам |
|
abuse_email |
email, по которому будут приниматься жалобы на спам |
|
phone |
контактный телефон |
|
address |
контактный адрес |
|
city |
город, где находится ваша компания |
|
zip |
почтовый индекс компании |
|
country |
страна в визитке отправителя: 7 – Россия; 10 – Азербайджан; 50 – Эстония; 54 – Франция; 58 – Грузия; 59 – Германия; 66 – Тайланд; 71 – Казахстан; 74 – Ирландия; 83 – Киргизия; 85 – Латвия; 102 – Молдавия; 129 – Армения; 143 – Испания; 165 – Узбекистан; 207 – Маршалловы острова; 260 – Таджикистан; 380 – Украина; 375 – Беларусь; 972 – Израиль |
|
url |
url вашего сайта, где можно подписаться/отписаться на базу |
|
unsub |
наличие переадресации при отписке получателя (0 - нет, 1 - да) |
|
eng |
английская версия письма при отписке (0 - нет, 1 - да) |
|
redirect |
переадресация получателя после отписки |
|
sub_redirect |
переадресация получателя после подтверждения подписки |
|
count |
сериализированный массив количеством получателей: active – кол-во активных получателей inactive - кол-во неактивных получателей unsubscribed - кол-во отписавшихся получателей bounced – кол-во получателей от которых отбивались письма all - общее кол-во получателей |
|
bounce_rate |
процент отбитых писем |
|
updated |
обновлялась ли база |
|
stat |
сериализированный массив статистики по базе получателей: open_rate - процент получателей, открывших письма click_rate - процент кликов среди подписчиков |
|
stat_update_time |
время последнего обновления статистики базы |
|
count_active |
количество активных подписчиков в базе |
|
count_all |
общее количество подписчиков в базе |
|
count_bounced |
количество подписчиков, от которых отбивались письма |
|
count_unsubscribed |
количество отписавшихся подписчиков |
Добавление адресной базы
POST
username=user&password=userpasswd&method=lists.add&name=Testbase&abuse_email=usermail@mail.com&abuse_name=OwnerName&company=CompanyName&address=MyAddress&city=Spb&zip=190000&country=Russia&url=mysite.com&phone=79999999999
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
name |
название адресной базы. Обязательный |
|
abuse_email |
email, по которому будут приниматься жалобы на спам |
|
abuse_name |
имя человека, которому можно жаловаться на спам |
|
company |
название вашей компании, владеющей адресной базой |
|
address |
контактный адрес |
|
city |
город, где находится ваша компания |
|
zip |
почтовый индекс компании |
|
country |
страна, где вы находитесь |
|
url |
url вашего сайта, где можно подписаться/отписаться на базу |
|
phone |
контактный телефон |
Ответ
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {"list_id": 1570}}}
|
Параметры |
Описание |
|
list_id |
id созданной базы. |
Обновление контактной информации адресной базы
POST
username=user&password=userpasswd&method=lists.update&list_id=1570&name=Testbase&abuse_email=usermail@mail.com&abuse_name=OwnerName&company=CompanyName&address=MyAddress&city=Spb&zip=190000&country=Russia&url=mysite.com&phone=79999999999
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
id редактируемой базы. Обязательный |
|
name |
название адресной базы |
|
abuse_email |
email, по которому будут приниматься жалобы на спам |
|
abuse_name |
имя человека, которому можно жаловаться на спам |
|
company |
название вашей компании, владеющей адресной базой |
|
address |
контактный адрес |
|
city |
город, где находится ваша компания |
|
zip |
почтовый индекс компании |
|
country |
страна, где вы находитесь |
|
url |
url вашего сайта, где можно подписаться/отписаться на базу |
|
phone |
контактный телефон |
Ответ:
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Удаление адресной базы
POST
username=user&password=userpasswd&method=lists.delete&list_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
id удаляемой базы. Обязательный. |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {"deleted_members": "5"}}}
|
Параметры |
Описание |
|
deleted_members |
количество удаленных активных подписчиков из удаленной базы |
Получение списка подписчиков с возможностью фильтрации и регулировки выдачи
POST
username=user&password=userpasswd&method=lists.get_members&list_id=123&state=active&limit=1
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
id адресной базы. Обязательный |
|
state |
статус подписчиков в базе: active - активные unsubscribed - отписавшиеся bounced - подписчики с отбивающимися письмами |
|
start |
номер подписчика в базе, с которого начинается выдача данных |
|
limit |
кол-во выдаваемых подписчиков |
|
order |
порядок сортировки, вида "поле порядок", например, "id desc" |
|
member_id |
id необходимого подписчика |
|
|
email необходимого подписчика |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"id": "40",
"list_id": "844",
"email": "subscriber@mail.com",
"state": "active",
"merge_1": "Иван",
"merge_2": "Иванов",
"merge_3": "1985-11-23 00:00:00",
"merge_4": "79999999999",
"merge_5": "Иванович",
"merge_6": "",
"optin_time": "2017-03-14 11:27:18",
"bounce_time": "0000-00-00 00:00:00",
"unsub_time": "0000-00-00 00:00:00",
"lastedit_time": "0000-00-00 00:00:00",
"gender": "m"}]}}
|
Параметры |
Описание |
|
id |
id подписчика |
|
list_id |
адресная база в которой состоит подписчик |
|
|
email подписчика |
|
state |
статус подписчика |
|
merge_{1..10} |
доп. поля подписчика |
|
optin_time |
время добавления в базу |
|
unsub_time |
время отписки из базы |
|
lastedit_time |
время последнего редактирования |
|
gender |
пол подписчика: m – мужской f – женский n - неизвестно |
Импортирование подписчиков из файла
POST
username=user&password=userpasswd&method=lists.upload&list_id=123&file=http://www.mysite.ru/files/file.csv&email=0&type=csv
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
адресная база в которую загружается файл. Обязательный |
|
file |
url импортируемого файла. Обязательный |
|
|
номер столбца импортируемого файла, содержащего email (счет от 0) . Обязательный |
|
type |
расширение импортируемого файла ("xls","csv","xlsx","xml","ods","slk","gnumeric"). Обязательный |
|
merge_{1..10} |
номер столбца дополнительного поля (счет от 0; параметр обязателен, если поле является обязательным в базе) |
|
update |
обновлять существующие записи, если этот параметр задан (например, true) |
|
sheet_index |
номер листа в xls-книге (по умолчанию - первый) |
|
sheet_name |
название листа в xls-книге (по умолчанию - первый) |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"text": "Импортировано 2 получателей.",
"type": "success"}}}
|
Параметры |
Описание |
|
text |
сообщение о результате импорта |
|
type |
результат импорта (success или errors) |
Добавление одного подписчика в базу
POST
username=user&password=userpasswd&method=lists.add_member&list_id=123&email=testuser@mail.com&merge_1=Иван&merge_2=Иванов&merge_3=1985-11-23&gender=m
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
адресная база в которую добавляется подписчик. Обязательный |
|
|
email подписчика. Обязательный |
|
merge_{1..10} |
столбцы дополнительных полей |
|
update |
обновлять существующие записи, если этот параметр задан (например, true) |
|
gender |
пол подписчика: m – мужской f – женский n - неизвестно |
|
no_check |
не проверять валидность адреса, если этот параметр задан |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"member_id": 6}}}
|
Параметры |
Описание |
|
member_id |
id добавленного подписчика |
Добавление нескольких подписчиков в базу
POST
username=user&password=userpasswd&method=lists.add_member_batch&list_id=123&batch=usermail1@mail.com,Анна,Михайлова,1980-10-15;usermail2@mail.com,Петр,Петров
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
адресная база в которую добавляется подписчик. Обязательный |
|
batch |
строка подписчиков с разделителями ";" и "," в следующем виде: email_1,merge_1,merge_2,merge_3,merge_4,merge_5,merge_6,merge_7,merge_8,merge_9,merge_10; email_2,merge_1,merge_2,merge_3,merge_4,merge_5,merge_6,merge_7,merge_8,merge_9,merge_10;, где email_1 и email_2 - email-адреса подписчиков, а merge_{1..10} - соответствующие им дополнительные поля. Каждый подписчик в строке разделяется точкой с запятой ";", дополнительные поля - запятой ",". Обязательный |
|
update |
обновлять существующие записи, если этот параметр задан (например, true) |
|
no_check |
не проверять валидность адреса, если этот параметр задан |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"member_ids": "8,9"}}}
|
Параметры |
Описание |
|
member_ids |
id добавленных подписчиков |
Редактирование данных подписчика
POST
username=user&password=userpasswd&method=lists.update_member&member_id=123&gender=m&merge_1=Иван&merge_2=Иванов&merge_3=1985-11-23
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
member_id |
id необходимого подписчика |
|
merge_{1..10} |
доп. поле в базе адресатов |
|
gender |
пол подписчика: m – мужской f – женский n - неизвестно |
Ответ
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Удаление подписчика из базы
POST
username=user&password=userpasswd&method=lists.delete_member&member_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
member_id |
id удаляемого подписчика |
Ответ
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Отписка подписчика из базы
POST
username=user&password=userpasswd&method=lists.unsubscribe_member&member_id=123&email=usermail@mail.com&list_id=321&reason=Отписка по заявке
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
member_id |
id отписываемого подписчика. Обязательный в случае отсутствия параметра email |
|
|
email отписываемого подписчика. Обязательный в случае отсутствия параметра member_id |
|
list_id |
адресная база из которой надо отписать подписчика. Если не задан - отписывается из всех баз |
|
reason |
причина отписки |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"unsubscribed": 1}}}
|
Параметры |
Описание |
|
unsubscribed |
количество отписанных подписчиков |
Перемещение подписчика в другую базу адресатов
POST
username=user&password=userpasswd&method=lists.move_member&member_id=3&list_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
member_id |
id перемещаемого подписчика. Обязательный |
|
list_id |
адресная база в которую надо переместить подписчика. Обязательный |
Ответ:
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Копирование подписчика в другую базу адресатов
POST
username=user&password=userpasswd&method=lists.copy_member&member_id=3&list_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
member_id |
id копируемого подписчика. Обязательный |
|
list_id |
адресная база в которую надо скопировать подписчика. Обязательный |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"copy_id": 124}}}
|
Параметры |
Описание |
|
copy_id |
id нового подписчика-копии. Обязательный |
Добавить дополнительное поле в базу адресатов
POST
username=user&password=userpasswd&method=lists.add_merge&list_id=123&type=choice&choices=a:3:{i:0;s:12:"Первый";i:1;s:12:"Второй";i:2;s:12:"Третий";}&title=New Field&req=off&var=%НОВОЕ ПОЛЕ%
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
адресная база. Обязательный |
|
type |
тип поля. Обязательный. Возможные значения: text – тектовое number – числовое date – дата choice – выбор из списка |
|
choices |
сериализированный массив элементов списка. Обязательный, если type = choice |
|
title |
название поля |
|
req |
обязательное ли поле? Возможные значения: on - да, off - нет |
|
var |
название шаблона. Должно быть вида %ШАБЛОН% |
Ответ:
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Обновление дополнительного поля в базе адресатов
POST
username=user&password=userpasswd&method=lists.update_merge&list_id=123&merge_id=7&title=New Title&req=off&var=%НОВЫЙШАБЛОН%
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
адресная база. Обязательный |
|
merge_id |
номер изменяемого дополнительного поля. Обязательный. |
|
choices |
сериализированный массив элементов списка. Обязательный, если type = choice |
|
title |
новое название поля |
|
req |
обязательное ли поле? Возможные значения: on - да, off - нет |
|
var |
новое название шаблона. Должно быть вида %ШАБЛОН% |
Ответ:
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Удаление дополнительного поля в базе адресатов
POST
username=user&password=userpasswd&method=lists.delete_merge&list_id=123&merge_id=7
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
адресная база. Обязательный |
|
merge_id |
номер удаляемого дополнительного поля. Обязательный. |
Ответ:
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Получение результата последнего импортирования базы адресатов
POST
username=user&password=userpasswd&method=lists.get_import_result&list_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
адресная база. Обязательный |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"import_result": "Импортировано 10 получателей. Дубликаты: 1 Ранее в жестких вовзратах: 1"}}}
|
Параметры |
Описание |
|
import_result |
результат последнего импорта |
Коды ошибок
|
Код ошибки |
Описание |
|
2 |
ошибка при добавлении в базу |
|
3 |
заданы не все необходимые параметры |
|
4 |
нет данных при выводе |
|
5 |
у пользователя нет адресной базы с таким id |
|
6 |
некорректный email-адрес |
|
7 |
такой пользователь уже есть в этой адресной базе |
|
8 |
лимит по количеству активных подписчиков на тарифном плане клиента |
|
9 |
нет такого подписчика у клиента |
|
10 |
пользователь уже отписан |
|
11 |
нет данных для обновления подписчика |
|
12 |
не заданы элементы списка |
|
13 |
не задано время рассылки |
|
14 |
не задан заголовок письма |
|
15 |
не задано поле От Кого |
|
16 |
не задан обратный адрес |
|
17 |
не задана ни html ни plain_text версия письма |
|
18 |
нет ссылки отписаться [ссылки с id="unsub_link"] в тексте рассылки. Пример ссылки: <a id="unsub_link" href="%ОТПИСАТЬСЯ%">отписаться</a> |
|
19 |
нет ссылки отписаться [%ОТПИСАТЬСЯ%] в тексте рассылки |
|
20 |
задан недопустимый статус рассылки |
|
21 |
рассылка уже отправляется |
|
22 |
нет рассылки с таким campaign_id |
|
23 |
нет такого поля для сортировки |
|
24 |
заданы недопустимые события для авторассылки |
|
25 |
загружаемый файл уже существует |
|
26 |
загружаемый файл больше 5 Мб |
|
27 |
файл не найден |
|
28 |
указанный шаблон не существует |
|
29 |
определен одноразовый email-адрес |
|
30 |
отправка рассылок заблокирована по подозрению в спаме |
|
31 |
массив email-адресов пуст |
|
32 |
нет корректных адресов для добавления |
|
33 |
остановка рассылки невозможна |
|
34 |
превышен максимальный размер html |
|
10010 |
невозможно получить данные из поля merge. Проверьте корректность передачи значения этого поля |
Оглавление:
Получение списка рассылок
POST
username=user&password=userpasswd&method=campaigns.get&campaign_id=123456
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id запрашиваемой рассылки. Обязательный. |
|
status |
статус рассылки {DRAFT, PAUSED, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED, SUBSCRIBE} |
|
list_id |
фильтр рассылок по адресным базам |
|
limit |
фильтр количества возвращаемых рассылок (начиная от самой новой) |
|
type |
тип кампании {online_builder, html} (онлайн-редактор, html-шаблон) |
Ответ
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"id": "123456",
"type": "plain_text",
"status": "CREATED",
"name": "Тест рассылки",
"list_id": "a:1:{i:0;i:473;}",
"subject": "Тест",
"from_name": "Название компании",
"from_email": "ts3@stream-telecom.ru",
"personalizeToEmail": "off",
"to_email": "",
"track_opens": "Y",
"track_clicks": "N",
"plain_clicks": "N",
"analytics": "N",
"analytics_tag": "",
"no_images_add": "1",
"no_plain_text": "0",
"WYSIWYG": "0",
"creation_time": "0000-00-00 00:00:00",
"delivery_time": "2017-04-19 12:30:56",
"allow_time_zone": "0",
"ds_task_id": "0",
"ds_sent": "0",
"esegment": "a:1:{i:473;a:2:{s:5:\"match\";s:3:\"any\";s:1:\"c\";a:1:{i:0;a:3:{s:5:\"field\";s:5:\"email\";s:2:\"op\";s:8:\"contains\";s:5:\"value\";s:3:\"alx\";}}}}",
"sqleseg": "a:1:{i:473;s:23:\"(l.email like '%alx%') \";}",
"relay_id": "0",
"problems": "",
"style": "1",
"order": "",
"header": "0",
"limit": "0",
"split": "",
"split_cond": "0",
"spamtests": "0",
"auto": "0",
"emails_to_send": "1",
"elapsed_time": "0",
"email_size": "0",
"show_preview": "1",
"show_abstract": "1",
"show_provider": "1",
"emails_sent": "0",
"lang": "ru",
"block_reason": "0",
"archived": "0",
"dc": "0",
"paused_compensation": "0",
"plain_text_links": "0",
"last_edit_time": "2017-04-19 12:29:31",
"html": "<p>\r\n\tТекст письма.</p>\r\n<p>\r\n\t<a href=\"http://unsub_link_for_preview.com/\" id=\"unsub_link\">Отписаться</a></p>\r\n",
"css": "",
"plain_text": "Текст письма.\r\r[1]Отписаться\r\rСсылки в данном письме:\r\r1. %ОТПИСАТЬСЯ%"}]}}
|
Параметр |
Описание |
|
id |
id рассылки |
|
type |
тип рассылки. возможные значения: online_builder, html |
|
status {DRAFT, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED} |
статус рассылки {DRAFT, PAUSED, SCHEDULE, MODERATING, CREATED, PROCESSING, SENT, BLOCKED, SUBSCRIBE} |
|
name |
название рассылки |
|
list_id |
адресная база, по которой производится рассылка |
|
subject |
заголовок письма |
|
from_name |
имя отправителя письма |
|
from_email |
обратный адрес |
|
personalizeToEmail {on/off} |
включить/выключить персонализацию в поле "Кому:" |
|
to_email |
персонализация в поле "Кому:" [можно использовать тэги из дополнительных полей базы, например %EMAIL%] |
|
track_opens {Y,N} |
следить за открыванием |
|
track_clicks {Y,N} |
отслеживать клики |
|
plain_clicks {Y,N} |
отслеживать клики в текстовой версии |
|
analytics {google,N} |
добавить Google Analytics™ для отслеживания всех URLs |
|
analytics_tag |
текстовый тег, как рассылка будет отображаться в Google Analytics™ |
|
html |
код html-версии письма |
|
css |
css-код html-версии письма в случае использования онлайн-редактора |
|
plain_text |
текстовая версия письма |
|
delivery_time |
время отправки рассылки |
|
auto {0,1,2} |
статус для авторассылки (0 - не активна, 1 - активна, 2 - в архиве) |
|
emails_sent |
общее число отправленных писем в рамках этой рассылки |
Создание рассылки
POST
username=user&password=userpasswd&method=campaigns.create&list_id=123456&name=newcampaign&subject=Test&html=<html>...</html>
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
индексный массив адресных баз, по которым будет создана рассылка. Структура: порядковый номер (от нуля) => id базы. Обязательный |
|
name |
название рассылки |
|
subject |
заголовок письма |
|
from_name |
имя отправителя письма |
|
from_email |
обратный адрес |
|
personalizeToEmail {on/off} |
включить/выключить персонализацию в поле "Кому:" [по умолчанию: off] |
|
to_email |
персонализация в поле "Кому:" [можно использовать тэги из дополнительных полей базы, например %EMAIL%] |
|
track_opens {Y,N} |
следить за открыванием [по умолчанию: Y] |
|
track_clicks {Y,N} |
отслеживать клики [по умолчанию: Y] |
|
plain_clicks {Y,N} |
отслеживать клики в текстовой версии [по умолчанию: N] |
|
no_images_add {0,1} |
не прикладывать картинки к письму. [по умолчанию: 0] - прикладываются. Помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены |
|
analytics - {google,N} |
добавить Google Analytics™ для отслеживания всех URLs [по умолчанию: N] |
|
analytics_tag |
текстовый тег, как рассылка будет отображаться в Google Analytics™, например: Рассылка_09_07_2011 |
|
html |
код html-версии письма либо номер сохраненного шаблона |
|
plain_text |
текстовая версия письма |
|
esegment |
сегменты баз для рассылки. Структура массива: id базы => массив сегмента. Структура массивов сегмента: [match] = {any|all} - должны выполняться все или любые из условия. [c] - массив условий. Содержит поля: [field] - тип поля (email, merge_{1..5}), [op] - условие {is, is not, contains, notcontain, starts, ends, greater, less}, [value] - значение поля. Например: array['match']='any';array['c'][0]['field']='email';array['c'][0]['op']='is';array['c'][0]['value']='user@mail.com'; |
Ответ
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {"campaign_id": 125033}}}
|
Параметры |
Описание |
|
campaign_id |
id созданной рассылки |
Создание авторассылки
POST
username=user&password=userpasswd&method=campaigns.create_auto&list_id=123456&name=newcampaignauto&subject=Testauto&html=<html>...</html>&action=form&dealy_1=3&delay_2=hour&auto=1&from_name=UserName&from_email=user@mail.com
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
list_id |
индексный массив адресных баз, на события в которых будет реагировать авторассылка. Структура: порядковый номер (от нуля) => id базы (только для событий добавления в базу и изменения доп. полей). Обязательный |
|
name |
название рассылки |
|
subject |
заголовок письма |
|
from_name |
имя отправителя письма |
|
from_email |
обратный адрес |
|
personalizeToEmail {on/off} |
включить/выключить персонализацию в поле "Кому:" [по умолчанию: off] |
|
to_email |
персонализация в поле "Кому:" [можно использовать тэги из дополнительных полей базы, например %EMAIL%] |
|
track_opens {Y,N} |
следить за открыванием [по умолчанию: Y] |
|
track_clicks {Y,N} |
отслеживать клики [по умолчанию: Y] |
|
plain_clicks {Y,N} |
отслеживать клики в текстовой версии [по умолчанию: N] |
|
no_images_add {0,1} |
не прикладывать картинки к письму. [по умолчанию: 0] - прикладываются. Помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены |
|
analytics - {google,N} |
добавить Google Analytics™ для отслеживания всех URLs [по умолчанию: N] |
|
analytics_tag |
текстовый тег, как рассылка будет отображаться в Google Analytics™, например: Рассылка_09_07_2011 |
|
html |
код html-версии письма либо номер сохраненного шаблона |
|
plain_text |
текстовая версия письма |
|
delay_1 |
время задержки |
|
delay_2 {hour, day, week} |
единица измерения времени задержки |
|
campaigns |
перечисленные через запятую id рассылок, на открытия или клики в которых должна реагировать авторассылка - для события open или номера полей, на изменение которых должна реагировать авторассылка - для события edit. для события href - запись вида id рассылки:url ссылки (которая есть в этой рассылке). |
|
auto {0,1} |
состояние авторассылки: 0 - черновик, 1 - активна |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"campaign_id": 125034}}}
|
Параметры |
Описание |
|
campaign_id |
id созданной авторассылки |
Обновление параметров рассылки
POST
username=user&password=userpasswd&method=campaigns.update&campaign_id=123456&name=ChangeName&track_clicks=Y&analytics=Y
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id обновляемой рассылки. Обязательный |
|
list_id |
индексный массив адресных баз, по которым будет создана рассылка. Структура: порядковый номер (от нуля) => id базы |
|
name |
название рассылки |
|
subject |
заголовок письма |
|
from_name |
имя отправителя письма |
|
from_email |
обратный адрес |
|
personalizeToEmail {on/off} |
включить/выключить персонализацию в поле "Кому:" [по умолчанию: off] |
|
to_email |
персонализация в поле "Кому:" [можно использовать тэги из дополнительных полей базы, например %EMAIL%] |
|
track_opens {Y,N} |
следить за открыванием [по умолчанию: Y] |
|
track_clicks {Y,N} |
отслеживать клики [по умолчанию: Y] |
|
plain_clicks {Y,N} |
отслеживать клики в текстовой версии [по умолчанию: N] |
|
no_images_add {0,1} |
не прикладывать картинки к письму. [по умолчанию: 0] - прикладываются. Помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены |
|
analytics - {google,N} |
добавить Google Analytics™ для отслеживания всех URLs [по умолчанию: N] |
|
analytics_tag |
текстовый тег, как рассылка будет отображаться в Google Analytics™, например: Рассылка_09_07_2011 |
|
html |
код html-версии письма либо номер сохраненного шаблона |
|
plain_text |
текстовая версия письма |
|
status {DRAFT, PAUSED SCHEDULE, MODERATING} |
{DRAFT, PAUSED SCHEDULE, MODERATING} перевод в статус SCHEDULE или MODERATING возможен только если рассылка удовлетворяет ряду условий: · заданы $subject, $from_name, $from_email · задана $html или $plain_text версия письма · есть ссылка на отписку для html-версии (Пример ссылки: <a id="unsub_link" href="%ОТПИСАТЬСЯ%">отписаться</a>) и %ОТПИСАТЬСЯ% для plain-text версии
if (status=SCHEDULE) : delivery_time в формате mysql: YYYY-MM-DD HH:MM:SS |
|
esegment |
сегменты баз для рассылки. Структура массива: id базы => массив сегмента. Структура массивов сегмента: [match] = {any|all} - должны выполняться все или любые из условия. [c] - массив условий. Содержит поля: [field] - тип поля (email, merge_{1..5}), [op] - условие {is, is not, contains, notcontain, starts, ends, greater, less}, [value] - значение поля. Например: array['match']='any';array['c'][0]['field']='email';array['c'][0]['op']='is';array['c'][0]['value']='user@mail.com'; |
Ответ:
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Обновление параметров авторассылки
POST
username=user&password=userpasswd&method=campaigns.update_auto&campaign_id=123456&name=ChangeName&track_clicks=Y&analytics=Y
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id обновляемой авторассылки. Обязательный |
|
list_id |
индексный массив адресных баз, на события в которых будет реагировать авторассылка. Структура: порядковый номер (от нуля) => id базы (только для событий добавления в базу и изменения доп. полей). |
|
name |
название рассылки |
|
subject |
заголовок письма |
|
from_name |
имя отправителя письма |
|
from_email |
обратный адрес |
|
personalizeToEmail {on/off} |
включить/выключить персонализацию в поле "Кому:" [по умолчанию: off] |
|
to_email |
персонализация в поле "Кому:" [можно использовать тэги из дополнительных полей базы, например %EMAIL%] |
|
track_opens {Y,N} |
следить за открыванием [по умолчанию: Y] |
|
track_clicks {Y,N} |
отслеживать клики [по умолчанию: Y] |
|
plain_clicks {Y,N} |
отслеживать клики в текстовой версии [по умолчанию: N] |
|
no_images_add {0,1} |
не прикладывать картинки к письму. [по умолчанию: 0] - прикладываются. Помогает проходить спам-фильтры и отображает картинки даже у тех получателей, у кого они по умолчанию отключены |
|
analytics - {google,N} |
добавить Google Analytics™ для отслеживания всех URLs [по умолчанию: N] |
|
analytics_tag |
текстовый тег, как рассылка будет отображаться в Google Analytics™, например: Рассылка_09_07_2011 |
|
html |
код html-версии письма либо номер сохраненного шаблона |
|
plain_text |
текстовая версия письма |
|
action |
события, на которые реагирует авторассылка. допустимые значения: open - открытие письма, click - переход по ссылке в письме, href - переход по определенной ссылке, edit - изменение доп. полей подписчика или любая (перечислять через запятую) комбинация из {form - подписка через форму, add - ручное добавление, upload - импорт}. по умолчанию - подписка через форму |
|
delay_1 |
время задержки |
|
delay_2 {hour, day, week} |
единица измерения времени задержки |
|
campaigns |
перечисленные через запятую id рассылок, на открытия или клики в которых должна реагировать авторассылка - для события open или номера полей, на изменение которых должна реагировать авторассылка - для события edit. для события href - запись вида id рассылки:url ссылки (которая есть в этой рассылке). |
|
auto {0,1} |
состояние авторассылки: 0 - черновик, 1 - активна |
Ответ:
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Удаление рассылки
POST
username=user&password=userpasswd&method=campaigns.delete&campaign_id=123456
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id удаляемой рассылки. Обязательный |
Ответ:
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Прикрепление файла к рассылке
POST
username=user&password=userpasswd&method=campaigns.attach&campaign_id=123456
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id рассылки. Обязательный |
|
url |
путь к вложению. Обязательный |
|
name |
название файла после загрузки |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"id": 64}}}
|
Параметры |
Описание |
|
id |
id приложенного файла |
Получение приложенных файлов
POST
username=user&password=userpasswd&method=campaigns.get_attachments&campaign_id=123456
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id рассылки. Обязательный |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"id": "64",
"campaign_id": "125042",
"name": "12345.csv",
"size": "42",
"updated_at": "2017-04-20 13:53:37"}]}}
|
Параметры |
Описание |
|
id |
id приложенного файла |
|
campaign_id |
id рассылки |
|
name |
название файла |
|
size |
размер файла в байтах |
|
updated_at |
время добавления |
Удаление приложенных файлов
POST
username=user&password=userpasswd&method=campaigns.delete_attachment&campaign_id=123456&id=15
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id рассылки. Обязательный |
|
id |
id приложенного файла |
Ответ
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Получение html шаблонов
POST
username=user&password=userpasswd&method=campaigns.get_templates&name=tmp&id=15
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
name |
название получаемого шаблона. Обязательный если отстутствует параметр id |
|
id |
id получаемого шаблона. Обязательный если отсутствует параметр name |
Ответ
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"id": "15",
"name": "tmp",
"html": "<html>...</html>\""}]}}
|
Параметры |
Описание |
|
id |
id шаблона |
|
name |
название шаблона |
|
html |
html шаблона |
Добавление html шаблона
POST
username=user&password=userpasswd&method=campaigns.add_template&name=tmp&template=<html>...</html>
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
name |
название шаблона. Обязательный |
|
template |
html-код, либо id рассылки, откуда взят html. Обязательный |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"id": 68}}}
|
Параметры |
Описание |
|
id |
id добавленного шаблона |
Удаление html шаблона
POST
username=user&password=userpasswd&method=campaigns.delete_template&id=15
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
id |
id шаблона |
Ответ:
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Принудительный вызов авторассылки
POST
username=user&password=userpasswd&method=campaigns.force_auto&campaign_id=132478&member_id=15&delay=1000
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id авторассылки. Обязательный |
|
member_id |
id получателя в адресной базе. Обязательный |
|
delay |
время задержки отправки (в мс). Обязательный |
Ответ:
Если значение msg[err_code] равно 0, то операция прошла успешно
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": true}}
Коды ошибок
|
Код ошибки |
Описание |
|
2 |
ошибка при добавлении в базу |
|
3 |
заданы не все необходимые параметры |
|
4 |
нет данных при выводе |
|
5 |
у пользователя нет адресной базы с таким id |
|
6 |
некорректный email-адрес |
|
7 |
такой пользователь уже есть в этой адресной базе |
|
8 |
лимит по количеству активных подписчиков на тарифном плане клиента |
|
9 |
нет такого подписчика у клиента |
|
10 |
пользователь уже отписан |
|
11 |
нет данных для обновления подписчика |
|
12 |
не заданы элементы списка |
|
13 |
не задано время рассылки |
|
14 |
не задан заголовок письма |
|
15 |
не задано поле От Кого |
|
16 |
не задан обратный адрес |
|
17 |
не задана ни html ни plain_text версия письма |
|
18 |
нет ссылки отписаться [ссылки с id="unsub_link"] в тексте рассылки. Пример ссылки: <a id="unsub_link" href="%ОТПИСАТЬСЯ%">отписаться</a> |
|
19 |
нет ссылки отписаться [%ОТПИСАТЬСЯ%] в тексте рассылки |
|
20 |
задан недопустимый статус рассылки |
|
21 |
рассылка уже отправляется |
|
22 |
нет рассылки с таким campaign_id |
|
23 |
нет такого поля для сортировки |
|
24 |
заданы недопустимые события для авторассылки |
|
25 |
загружаемый файл уже существует |
|
26 |
загружаемый файл больше 5 Мб |
|
27 |
файл не найден |
|
28 |
указанный шаблон не существует |
|
29 |
определен одноразовый email-адрес |
|
30 |
отправка рассылок заблокирована по подозрению в спаме |
|
31 |
массив email-адресов пуст |
|
32 |
нет корректных адресов для добавления |
|
33 |
остановка рассылки невозможна |
|
34 |
превышен максимальный размер html |
|
10010 |
невозможно получить данные из поля merge. Проверьте корректность передачи значения этого поля |
Оглавление:
Получение списка отправленных писем в рассылкеPOST
username=user&password=userpasswd&method=reports.sent&campaign_id=123&limit=2&order=email asc
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id запрашиваемой рассылки. Обязательный. |
|
start |
номер записи с которой начинать вывод [по умолчанию: 0] |
|
limit |
количество записей для вывода [по умолчанию: 100] |
|
order |
поле, по которому можно сортировать и порядок сортировки (asc - по возрастанию, desc - по убыванию) |
Ответ
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"id": "8",
"member_id": "4",
"campaign_id": "123",
"list_id": "339",
"bounce_code": "",
"bounce_reason": "",
"email": "usermail1@mail.com",
"sent_time": "2017-02-08 13:45:11",
"open_time": "0000-00-00 00:00:00",
"clicked": "0",
"opened": "0",
"bounced": "0",
"unsubscribed": "0"},
{"id": "9",
"member_id": "5",
"campaign_id": "123",
"list_id": "339",
"bounce_code": "",
"bounce_reason": "",
"email": "usermail2@mail.com",
"sent_time": "2017-02-08 13:45:11",
"open_time": "2017-02-10 16:01:49",
"clicked": "0",
"opened": "1",
"bounced": "0",
"unsubscribed": "1"}
]}}
|
Параметр |
Описание |
|
id |
id письма |
|
member_id |
id подписчика |
|
campaign_id |
id рассылки |
|
status |
статус сообщения (CREATED, SENT, BOUNCED, UNSUBSCRIBED) |
|
bounce_code |
smtp-код ошибки в случае возврата сообщения |
|
bounce_reason |
расшифровка bounce_code в данном конкретном случае |
|
|
email получателя |
|
to_email |
персонализация в поле "Кому:" |
|
from_name |
имя отправителя |
|
from_email |
email отправителя |
|
subject |
тема письма |
|
html |
html-код письма |
|
plain_text |
текстовая версия письма |
|
delivery_time |
время доставки письма |
|
open_time |
время открытия письма |
|
clicked |
был ли переход по ссылкам в письме |
Получение списка доставленных писем в рассылке
POST
username=user&password=userpasswd&method=reports.delivered&campaign_id=123&limit=2&order=email asc
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id запрашиваемой рассылки. Обязательный. |
|
start |
номер записи с которой начинать вывод [по умолчанию: 0] |
|
limit |
количество записей для вывода [по умолчанию: 100] |
|
order |
поле, по которому можно сортировать и порядок сортировки (asc - по возрастанию, desc - по убыванию) |
Ответ
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{"id": "8","member_id": "4","campaign_id": "123","list_id": "339","bounce_code": "","bounce_reason": "","email": "usermail1@mail.com","sent_time": "2017-02-08 13:45:11","open_time": "0000-00-00 00:00:00","clicked": "0","opened": "0","bounced": "0","unsubscribed": "0"},{"id": "9","member_id": "5","campaign_id": "123","list_id": "339","bounce_code": "","bounce_reason": "","email": "usermail2@mail.com","sent_time": "2017-02-08 13:45:11","open_time": "2017-02-10 16:01:49","clicked": "0","opened": "1","bounced": "0","unsubscribed": "1"}]}}
|
Параметр |
Описание |
|
id |
id письма |
|
member_id |
id подписчика |
|
campaign_id |
id рассылки |
|
list_id |
id адресной базы из которой подписчик |
|
status |
статус сообщения (CREATED, SENT, BOUNCED, UNSUBSCRIBED) |
|
bounce_code |
smtp-код ошибки в случае возврата сообщения |
|
bounce_reason |
расшифровка bounce_code в данном конкретном случае |
|
|
email получателя |
|
to_email |
персонализация в поле "Кому:" |
|
from_name |
имя отправителя |
|
from_email |
email отправителя |
|
subject |
тема письма |
|
html |
html-код письма |
|
plain_text |
текстовая версия письма |
|
delivery_time |
время доставки письма |
|
open_time |
время открытия письма |
|
clicked |
был ли переход по ссылкам в письме |
Получение списка открытых писем в рассылке
POST
username=user&password=userpasswd&method=reports.opened&campaign_id=123&limit=2&order=email asc
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id запрашиваемой рассылки. Обязательный. |
|
start |
номер записи с которой начинать вывод [по умолчанию: 0] |
|
limit |
количество записей для вывода [по умолчанию: 100] |
|
order |
поле, по которому можно сортировать и порядок сортировки (asc - по возрастанию, desc - по убыванию) |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"id": "9",
"member_id": "5",
"campaign_id": "123",
"list_id": "339",
"bounce_code": "",
"bounce_reason": "",
"email": "usermail1@mail.com",
"sent_time": "2017-02-08 13:45:11",
"open_time": "2017-02-10 16:01:49",
"clicked": "0",
"opened": "1",
"bounced": "0",
"unsubscribed": "1"},
{"id": "17",
"member_id": "13",
"campaign_id": "123",
"list_id": "339",
"bounce_code": "",
"bounce_reason": "",
"email": "usermail2@mail.com",
"sent_time": "2017-02-08 13:45:11",
"open_time": "2017-02-08 13:48:15",
"clicked": "0",
"opened": "1",
"bounced": "0",
"unsubscribed": "0"}
]}}
|
Параметр |
Описание |
|
id |
id письма |
|
member_id |
id подписчика |
|
campaign_id |
id рассылки |
|
list_id |
id адресной базы из которой подписчик |
|
status |
статус сообщения (CREATED, SENT, BOUNCED, UNSUBSCRIBED) |
|
bounce_code |
smtp-код ошибки в случае возврата сообщения |
|
bounce_reason |
расшифровка bounce_code в данном конкретном случае |
|
|
email получателя |
|
to_email |
персонализация в поле "Кому:" |
|
from_name |
имя отправителя |
|
from_email |
email отправителя |
|
subject |
тема письма |
|
html |
html-код письма |
|
plain_text |
текстовая версия письма |
|
delivery_time |
время доставки письма |
|
open_time |
время открытия письма |
|
clicked |
был ли переход по ссылкам в письме |
Получение списка отписавшихся подписчиков в рассылке
POST
username=user&password=userpasswd&method=reports.unsubscribed&campaign_id=123&limit=2&order=email asc
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id запрашиваемой рассылки. Обязательный. |
|
start |
номер записи с которой начинать вывод [по умолчанию: 0] |
|
limit |
количество записей для вывода [по умолчанию: 100] |
|
order |
поле, по которому можно сортировать и порядок сортировки (asc - по возрастанию, desc - по убыванию) |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"id": "9",
"member_id": "5",
"campaign_id": "123",
"list_id": "339",
"bounce_code": "",
"bounce_reason": "",
"email": "usermail1@mail.com",
"sent_time": "2017-02-08 13:45:11",
"open_time": "2017-02-10 16:01:49",
"clicked": "0",
"opened": "1",
"bounced": "0",
"unsubscribed": "1"},
{"id": "17",
"member_id": "13",
"campaign_id": "123",
"list_id": "339",
"bounce_code": "",
"bounce_reason": "",
"email": "usermail2@mail.com",
"sent_time": "2017-02-08 13:45:11",
"open_time": "2017-02-08 13:48:15",
"clicked": "0",
"opened": "1",
"bounced": "0",
"unsubscribed": "0"}
]}}
|
Параметр |
Описание |
|
id |
id письма |
|
member_id |
id подписчика |
|
campaign_id |
id рассылки |
|
list_id |
id адресной базы из которой подписчик |
|
status |
статус сообщения (CREATED, SENT, BOUNCED, UNSUBSCRIBED) |
|
bounce_code |
smtp-код ошибки в случае возврата сообщения |
|
bounce_reason |
расшифровка bounce_code в данном конкретном случае |
|
|
email получателя |
|
to_email |
персонализация в поле "Кому:" |
|
from_name |
имя отправителя |
|
from_email |
email отправителя |
|
subject |
тема письма |
|
html |
html-код письма |
|
plain_text |
текстовая версия письма |
|
delivery_time |
время доставки письма |
|
open_time |
время открытия письма |
|
clicked |
был ли переход по ссылкам в письме |
Получение списка возвратившихся писем в рассылке
POST
username=user&password=userpasswd&method=reports.bounced&campaign_id=123&limit=1&order=email asc
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id запрашиваемой рассылки. Обязательный. |
|
start |
номер записи с которой начинать вывод [по умолчанию: 0] |
|
limit |
количество записей для вывода [по умолчанию: 100] |
|
order |
поле, по которому можно сортировать и порядок сортировки (asc - по возрастанию, desc - по убыванию) |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"id": "6",
"member_id": "8",
"campaign_id": "123",
"list_id": "339",
"bounce_code": "550",
"bounce_reason": "Not delivering to the previously bounced address",
"email": "usermail1@mail.com",
"sent_time": "2017-02-08 13:45:11",
"open_time": "0000-00-00 00:00:00",
"clicked": "0",
"opened": "0",
"bounced": "1",
"unsubscribed": "0"}]}}
|
Параметр |
Описание |
|
id |
id письма |
|
member_id |
id подписчика |
|
campaign_id |
id рассылки |
|
list_id |
id адресной базы из которой подписчик |
|
status |
статус сообщения (CREATED, SENT, BOUNCED, UNSUBSCRIBED) |
|
bounce_code |
smtp-код ошибки в случае возврата сообщения |
|
bounce_reason |
расшифровка bounce_code в данном конкретном случае |
|
|
email получателя |
|
to_email |
персонализация в поле "Кому:" |
|
from_name |
имя отправителя |
|
from_email |
email отправителя |
|
subject |
тема письма |
|
html |
html-код письма |
|
plain_text |
текстовая версия письма |
|
delivery_time |
время доставки письма |
|
open_time |
время открытия письма |
|
clicked |
был ли переход по ссылкам в письме |
Получение статистики по кликам в рассылке
POST
username=user&password=userpasswd&method=reports.clickstat&campaign_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id запрашиваемой рассылки. Обязательный |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"url": "https://www.mysite.ru/link_1.php?utm_source=newsletter&utm_medium=email&utm_campaign...;,
"clicks": "1"},{
"url": "https://www.mysite.ru/link_2.php?utm_source=newsletter&utm_medium=email&utm_campaign...;,
"clicks": "3"},{
"url": "https://www.mysite.ru/link_1.php?utm_source=newsletter&utm_medium=email&utm_campaign...;,
"clicks": "0"}]}}
|
Параметры |
Описание |
|
url |
адрес ссылки |
|
clicks |
общее число кликов по данной ссылке в рамках рассылки |
Получение статистики о причинах возврата писем в рассылке
POST
username=user&password=userpasswd&method=reports.bouncestat&campaign_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id, запрашиваемой рассылки. Обязательный |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": [{
"bounce_code": "550",
"count": "1",
"description": "The requested command failed because the user’s mailbox was unavailable (such as not found)"}]}}
|
Параметры |
Описание |
|
bounce_code |
smtp код ошибки |
|
count |
количество писем с такой ошибкой |
|
description |
типовое краткое описание ошибки |
Получение общей статистики рассылки
POST
username=user&password=userpasswd&method=reports.summary&campaign_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id, запрашиваемой рассылки. Обязательный |
Ответ:
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"clicks": "0",
"sent": "11",
"opened": "5",
"delivered": "10",
"bounced": "1",
"unsubscribed": "1"}}}
|
Параметры |
Описание |
|
clicks |
общее число кликов |
|
sent |
число отправленных сообщений |
|
opened |
число точно открытых писем |
|
delivered |
число доставленных сообщений |
|
bounced |
число возвращенных писем |
|
unsubscribed |
число отписавшихся подписчиков |
Получение статиситки по браузерам в рассылке
POST
username=user&password=userpasswd&method=reports.clients&campaign_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id, запрашиваемой рассылки. Обязательный |
Ответ
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"ie": 2,
"ie6": 2,
"ie11": null,
"chrome": 1,
"opera": null,
"firefox": 1,
"safari": null,
"yandexbrowser": null,
"other": 0,
"browsers": 6,
"iPhone": 0,
"iPad": null,
"samsung": null,
"other_mobile": 0,
"mobile": null,
"yandex": 0,
"mail": [["0"]],
"gmail": [["0"]],
"applemail": null,
"outlook": 2,
"thunderbird": null}}}
|
Параметры |
Описание |
|
ie |
число пользователей ie > 6 |
|
ie6 |
число пользователей ie6 |
|
chrome |
число пользователей chrome |
|
opera |
число пользователей opera |
|
firefox |
число пользователей firefox |
|
safari |
число пользователей safari |
|
|
число пользователей mail.ru |
|
yandex |
число пользователей yandex.ru |
|
outlook |
число пользователей outlook |
|
win |
число пользователей Windows |
|
linux |
число пользователей Linux |
|
mac |
число пользователей Mac |
Получение статистики по регионам в рассылке
POST
username=user&password=userpasswd&method=reports.geo&campaign_id=123
HTTP/1.1
Host: http://api.streamemail.ru/
Content-Type: application/x-www-form-urlencoded
|
Параметры |
Описание |
|
campaign_id |
id, запрашиваемой рассылки. Обязательный |
Ответ
{"response": {"msg": {"err_code": 0,"text": "OK","type": "message"},"data": {
"Санкт-Петербург": 4}}}
|
Параметры |
Описание |
|
название города или региона |
число открытий |
Коды ошибок
|
Код ошибки |
Описание |
|
2 |
ошибка при добавлении в базу |
|
3 |
заданы не все необходимые параметры |
|
4 |
нет данных при выводе |
|
5 |
у пользователя нет адресной базы с таким id |
|
6 |
некорректный email-адрес |
|
7 |
такой пользователь уже есть в этой адресной базе |
|
8 |
лимит по количеству активных подписчиков на тарифном плане клиента |
|
9 |
нет такого подписчика у клиента |
|
10 |
пользователь уже отписан |
|
11 |
нет данных для обновления подписчика |
|
12 |
не заданы элементы списка |
|
13 |
не задано время рассылки |
|
14 |
не задан заголовок письма |
|
15 |
не задано поле От Кого |
|
16 |
не задан обратный адрес |
|
17 |
не задана ни html ни plain_text версия письма |
|
18 |
нет ссылки отписаться [ссылки с id="unsub_link"] в тексте рассылки. Пример ссылки: <a id="unsub_link" href="%ОТПИСАТЬСЯ%">отписаться</a> |
|
19 |
нет ссылки отписаться [%ОТПИСАТЬСЯ%] в тексте рассылки |
|
20 |
задан недопустимый статус рассылки |
|
21 |
рассылка уже отправляется |
|
22 |
нет рассылки с таким campaign_id |
|
23 |
нет такого поля для сортировки |
|
24 |
заданы недопустимые события для авторассылки |
|
25 |
загружаемый файл уже существует |
|
26 |
загружаемый файл больше 5 Мб |
|
27 |
файл не найден |
|
28 |
указанный шаблон не существует |
|
29 |
определен одноразовый email-адрес |
|
30 |
отправка рассылок заблокирована по подозрению в спаме |
|
31 |
массив email-адресов пуст |
|
32 |
нет корректных адресов для добавления |
|
33 |
остановка рассылки невозможна |
|
34 |
превышен максимальный размер html |
|
10010 |
невозможно получить данные из поля merge. Проверьте корректность передачи значения этого поля |
