E-mail платформа app.prontosms.ru
- Игорь Козлитин
- Алексей Киричек
- 1 Общие сведения
- 2 Одиночные сообщения
- 3 Группы получателей
- 3.1 Создание группы
- 3.1.1 Параметры запроса
- 3.1.2 Ответ сервера
- 3.2 Получение списка групп
- 3.2.1 Ответ сервера
- 3.3 Получение информации о группе
- 3.3.1 Ответ сервера
- 3.4 Удаление группы
- 3.4.1 Ответ сервера
- 3.5 Редактирование группы
- 3.5.1 Параметры запроса
- 3.5.2 Ответ сервера
- 3.1 Создание группы
- 4 Параметры группы получателей
- 4.1 Создание параметра
- 4.1.1 Параметры запроса
- 4.1.2 Ответ сервера
- 4.2 Список параметров
- 4.2.1 Ответ сервера
- 4.3 Изменение параметра
- 4.3.1 Параметры запроса
- 4.3.2 Ответ сервера
- 4.4 Удаление параметра
- 4.1 Создание параметра
- 5 Получатели
- 5.1 Создание получателя
- 5.1.1 Параметры запроса
- 5.1.2 Ответ сервера
- 5.2 Обновление получателя
- 5.2.1 Параметры запроса
- 5.2.2 Ответ сервера
- 5.3 Список получателей
- 5.3.1 Ответ сервера
- 5.4 Удаление получателя
- 5.5 Импорт большого количества получателей
- 5.5.1 Параметры запроса
- 5.5.2 Ответ сервера
- 5.6 Поиск получателей
- 5.6.1 Параметры запроса
- 5.6.2 Ответ сервера
- 5.1 Создание получателя
- 6 Организации
- 6.1 Создание организации
- 6.1.1 Параметры запроса
- 6.1.2 Ответ сервера
- 6.2 Список организаций
- 6.2.1 Ответ сервера
- 6.3 Информация об организации
- 6.3.1 Ответ сервера
- 6.4 Организация по умолчанию
- 6.4.1 Ответ сервера
- 6.5 Задать организацию по умолчанию
- 6.5.1 Ответ сервера
- 6.6 Изменение организации
- 6.6.1 Параметры запроса
- 6.6.2 Ответ сервера
- 6.7 Удаление организации
- 6.1 Создание организации
- 7 Рассылки
- 7.1 Создание рассылки
- 7.1.1 Параметры запроса
- 7.1.2 Ответ сервера
- 7.2 Отправка рассылки
- 7.2.1 Ответ сервера
- 7.3 Информация о рассылке
- 7.1 Создание рассылки
- 8 Webhooks
- 8.1.1 Виды событий
- 8.2 Установка webhook
- 8.2.1 Параметры запроса
- 8.2.2 Ответ сервера
- 8.3 Получение информации о webhook
- 8.4 Удаление webhook
- 9 SMTP
- 9.1 Базовый URL
- 9.2 Аутентификация
Общие сведения
Данный документ содержит сведения о программном интерфейсе сервиса email рассылок (далее - «API»). Через API внешние приложения получают доступ к системе управлению списками получателей, отправке одиночных email сообщений, рассылок, а также прочий функционал для работы со списками получателей и статистикой рассылок.
Регистрация и вход в личный кабинет доступны по ссылке: app.prontosms.ru.
Базовый URL
Базовый URL для всех запросов
https://api-em.prontosms.ru/v1
Аутентификация
Для удостоверения подлинности запросов, в каждом обращении к API необходимо отправлять заголовок содержащий Ваш ключ.
Authorization: Bearer $API_TOKEN
Ключ для доступа к API можно получить в личном кабинете.
Держите Ваш ключ для доступа к API в секрете.
Формат обмена данных
Для обмена данными используется формат JSON, поэтому, в каждом запросе должен присутствовать заголовок
Content-Type: application/json
Все данные от сервера возвращаются так же, в формате JSON.
Получение списков данных (Collection)
Списки данных (Collection) - постраничный способ выдачи данных, используемый в некоторых методах Для управления страницами выдачи списка данных в заголовках запроса необходимо передавать параметры:
Пример запроса
curl -X GET https://api-em.prontosms.ru/v1/email/lists?page_number=2&page_size=3 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer $API_TOKEN'
Поддерживаемые параметры
Параметр | Описание |
|---|---|
page_number | Номер запрашиваемой страницы. По умолчанию: 1 |
page_size | Количество записей на странице. По умолчанию: 25 |
Если параметр page_size превышает максимально допустимый размер, то сервер ответит ошибкой со статусом 412:
{
"errors": [
{
"code": 412,
"detail": "Page size is too big. Max value is 100"
}
]
}
По умолчанию максимальный page_size равняется 100, если в описании конкретного метода не указано другое.
При выполнении запроса с использованием списка данных ответ будет возвращен в виде структуры:
Пример ответа со списком данных (Collection)
{
"total_count":23,
"total_pages":7,
"page_number":2,
"page_size":3,
"collection":[
{
"id":1,
"title":"My Recipients"
},
{
"id":2,
"title":"My Recipients #2"
},
{
"id":3,
"title":"My Recipients #3"
}
]
}
Ключ | Описание |
|---|---|
total_count | Общее количество элементов "collection" |
total_pages | Количество страниц |
page_number | Номер текущей страницы |
page_size | Количество записей на странице |
collection | Массив возвращаемых данных |
Обработка ответа
Обработка ответа может осуществляться при проверки кода состояния HTTP запроса. Так же в случае неуспешного выполнения запроса, ответ содержит массив данных c описанием ошибок в формате JSON.
Пример ответа с ошибками
Коды ответов
Код | Описание |
|---|---|
2xx | Запрос успешно выполнен |
400 | Неверные параметры |
401 | Аутентификация не пройдена |
402 | Недостаточно средств |
404 | Ресурс не найден |
415 | Неподдерживаемый тип данных |
422 | Ресурс не может быть обработан |
Ограничения на количество запросов
На данный момент есть ограничение в 5 запросов в секунду на любые запросы, кроме запросов типа GET. В случае превышения ограничения сервер вернет ответ со статусом 429.
Одиночные сообщения
Отправка одиночного email сообщения
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
Пример запроса для отправки сообщения с вложениями
POST /email/messages
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
from_email |
| Да |
from_name |
|
|
to |
| Да |
subject |
| Да |
text |
| Должен присутствовать хотя бы один параметр: |
html |
| Должен присутствовать хотя бы один параметр: |
attachments | Массив с вложениями. Поддерживается только для запросов с типом содержимого multipart/form-data |
|
payment | Способ тарификации сообщения. Возможные значения: |
|
Способы тарификации сообщения
Значение | Описание |
|---|---|
subscriber_priority | Тарифицируется "подписчик", если не доступны "подписчики", используется "письмо". Если нет "писем", возвращается ошибка. |
credit_priority | Тарифицируется "письмо". Если нет "писем", используется "подписчик". Если нет "подписчиков", возвращается ошибка. |
subscriber | Тарифицируется "подписчик". Если нет "подписчиков", возвращается ошибка. |
credit | Тарифицируется "письмо". Если нет "писем", возвращается ошибка. |
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор сообщения |
from_email | Адрес отправителя |
from_name | Имя отправителя |
to | Адрес получателя |
subject | Тема |
text | Текстовая версия сообщения |
html | HTML версия сообщения |
attachments | Массив имен вложенных файлов |
status | Статус сообщения |
events | Информация о событиях |
Статусы сообщения
Статус | Описание |
|---|---|
queued | Принято в очередь |
sent | Отправлено. Ожидается подтверждение доставки. |
delivered | Доставлено |
skipped | Не отправлено |
soft_bounced | Сообщение не доставлено |
hard_bounced | Сообщение не может быть доставлено |
Информация о событиях
Событие | Описание |
|---|---|
open | Сообщение прочитано |
redirect | Получатель перешел по ссылке |
spam | Сообщение помечено как спам |
unsubscribe | Пользователь отписался |
Обратите внимание на то, что при отправке сообщений сервер может вернуть ответ со статусом 429. Это означает, что вы превысили количество сообщений, разрешенное к отправке, в единицу времени. Результат отправки сообщений влияет на лимит сообщений в единицу времени. Таким образом, если вы отправляете письма только вашим клиентам, только на существующие адреса, не рассылаете спам и тп, то разрешенное количество сообщений в единицу времени для вашего аккаунта будет увеличиваться, и наоборот.
Получение информации о сообщении
Пример запроса
Пример ответа в случае успеха
GET /email/messages/:id
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
from_email | Адрес отправителя |
from_name | Имя отправителя |
to | Адрес получателя |
subject | Тема |
text | Текстовая версия сообщения |
html | HTML версия сообщения |
status | Статус сообщения |
events | Информация о событиях |
Статусы сообщения
Статус | Описание |
|---|---|
queued | Принято в очередь |
sent | Отправлено |
delivered | Доставлено |
skipped | Не отправлено |
soft_bounced | Сообщение не доставлено |
hard_bounced | Сообщение не может быть доставлено |
Информация о событиях
Событие | Описание |
|---|---|
open | Сообщение прочитано |
redirect | Получатель перешел по ссылке |
spam | Сообщение помечено как спам |
unsubscribe | Пользователь отписался |
Отправка одиночного сообщения по шаблону
В личном кабинете в разделе "Автоматизация", выберите "Одиночное по шаблону" и создайте шаблон письма. Отправляйте письма по этому шаблону с параметрами. Для подстановки параметра в шаблоне используйте конструкцию [%имя параметра%], например [%name%], [%age%] и т.д.
Пример JSON для запроса
POST /email/templates/:template_id/messages
где :template_id - идентификатор шаблона
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
to | email получателя | Да |
params | Параметры подстановки | Нет |
payment | Способ тарификации сообщения. Возможные значения: | Нет |
Способы тарификации сообщения
Значение | Описание |
|---|---|
subscriber_priority | Тарифицируется "подписчик", если не доступны "подписчики", используется "письмо". Если нет "писем", возвращается ошибка. |
credit_priority | Тарифицируется "письмо". Если нет "писем", используется "подписчик". Если нет "подписчиков", возвращается ошибка. |
subscriber | Тарифицируется "подписчик". Если нет "подписчиков", возвращается ошибка. |
credit | Тарифицируется "письмо". Если нет "писем", возвращается ошибка. |
Пример запроса
Группы получателей
Создание группы
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
POST /email/lists
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
title | Название группы получателей. Должно быть уникальным | Да |
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор созданной группы |
title | Название группы |
Получение списка групп
Пример запроса
Данный метод поддерживает постраничную выдачу результатов.
Пример ответа в случае успеха
GET /email/lists
Ответ сервера
Ответ сервера содержит коллекцию групп получателей. Каждый элемент содержит следующие атрибуты:
Атрибут | Описание |
|---|---|
id | Идентификатор группы |
title | Название группы |
Получение информации о группе
Пример запроса
Пример ответа в случае успеха
GET /email/lists/:id
где :id - идентификатор группы для запроса информации
Ответ сервера
Ответ сервера в формате JSON содержит следующие атрибуты:
Атрибут | Описание |
|---|---|
id | Идентификатор группы |
title | Название группы |
Удаление группы
Пример запроса
DELETE /email/lists/:id
где :id - идентификатор группы для запроса информации
Ответ сервера
В случае успешного удаления сервер вернет пустой ответ со статусом 204.
Редактирование группы
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
PATCH /email/lists/:id
где :id - идентификатор группы для запроса информации
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
title | Название группы получателей. Должно быть уникальным | Да |
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор созданной группы |
title | Название группы |
Параметры группы получателей
Создание параметра
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
POST /email/lists/:id/parameters
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
title |
| Да |
kind | Возможные значения: |
|
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
title | Название |
kind | Тип |
Список параметров
Пример запроса
Данный метод поддерживает постраничную выдачу результатов.
Пример ответа в случае успеха
GET /email/lists/:id/parameters
Ответ сервера
Ответ сервера содержит коллекцию параметров группы получателей. Каждый элемент содержит следующие атрибуты:
Атрибут | Описание |
|---|---|
id | Идентификатор |
title | Название |
kind | Тип |
Изменение параметра
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
PATCH /email/lists/:list-id/parameters/:id
где :list-id - идентификатор группы, :id - идентификатор параметра
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
title |
|
|
kind | Возможные значения: |
|
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
title | Название |
kind | Тип |
Удаление параметра
Пример запроса
DELETE /email/lists/:list-id/parameters/:id
где :list-id - идентификатор группы, :id - идентификатор параметра
Получатели
Создание получателя
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
POST /email/lists/:id/recipients
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
| Да | |
unconfirmed | Создать неподтвержденного получателя. Необходимо задать любое значение, например, true, t или 1. По умолчанию создается подтвержденный получатель | Нет |
values | Массив значений для параметров |
|
Элементы массива значений
Параметр | Описание | Обязательный |
|---|---|---|
parameter_id | ID параметра группы получателей | Да |
value |
| Да |
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
Адрес | |
confirmed | Подтвержден получатель или нет |
values | Массив значений |
Элементы массива значений
Параметр | Описание |
|---|---|
parameter_id | ID параметра группы получателей |
kind | Тип параметра |
value | Значение |
Обновление получателя
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
PATCH /email/lists/:list_id/recipients/:id
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
| Нет | |
values | Массив значений для параметров |
|
Элементы массива значений
Параметр | Описание | Обязательный |
|---|---|---|
parameter_id | ID параметра группы получателей | Да |
value | Не может быть одновременно использован с параметром destroy | Нет |
destroy | Используется для удаления значения. Для удаления значения необходимо задать любое значение, например, true, t или 1. Не можеть быть использован одновременно с параметром value | Нет |
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
Адрес | |
confirmed | Подтвержден получатель или нет |
values | Массив значений |
Элементы массива значений
Параметр | Описание |
|---|---|
parameter_id | ID параметра группы получателей |
kind | Тип параметра |
value | Значение |
Список получателей
Пример запроса
Данный метод поддерживает постраничную выдачу результатов. Максимальный page_size равняется 1000.
Пример ответа в случае успеха
GET /email/lists/:id/recipients
Ответ сервера
Ответ сервера содержит коллекцию получателей в группе. Каждый элемент содержит следующие атрибуты:
Атрибут | Описание |
|---|---|
id | Идентификатор |
Адрес | |
confirmed | Подтвержден получатель или нет |
values | Массив значений |
Элементы массива значений
Параметр | Описание |
|---|---|
parameter_id | ID параметра группы получателей |
kind | Тип параметра |
value | Значение |
Удаление получателя
Пример запроса
DELETE /email/lists/:list_id/recipients/:id
Импорт большого количества получателей
POST /email/lists/:id/recipients/imports
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
recipients | Массив получателей. Максимальный размер 10000 | Да |
run_triggers | Запустить связанные триггеры. Необходимо задать любое значение, например, true, t или 1. | Нет |
tags | Массив значений тегов | Нет |
callback_url | url, на который будет отправлен запрос после завершения импорта | нет |
Массив получателей recipients
Параметр | Описание | Обязательный |
|---|---|---|
Email получателя | Да | |
values | Массив значений параметров | Нет |
Элементы массива значений values
Параметр | Описание | Обязательный |
|---|---|---|
parameter_id | ID параметра группы получателей | Да |
value | Значение параметра | Да |
Ответ сервера
Параметр | Описание |
|---|---|
id | Идентификатор импорта. В дальнейшем может использоваться для получения информации о ходе импорта |
status | Статус импорта |
callback_url | url, на который будет отправлен запрос после окончании импорта |
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
Пример запроса после окончания импорта, если указан callback url
Поиск получателей
Данный метод позволяет осуществить поиск получателя по email, например, чтобы определить в каких группах есть данный получатель.
Пример запроса
Пример ответа в случае успеха
GET /email/recipients/search
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
Искомый адрес | Да |
Ответ сервера
Ответ сервера содержит коллекцию получателей в группе. Каждый элемент содержит следующие атрибуты:
Атрибут | Описание |
|---|---|
Адрес получателя | |
recipients | Массив, содержащий информацию о списках, в которых есть искомый получатель |
Организации
Создание организации
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
POST /email/organizations
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
name |
| Да |
address |
| Да |
country |
| Да |
city |
| Да |
phone |
| Да |
zip |
| Да |
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
name | Название |
address | Адрес |
country | Страна |
city | Город |
phone | Телефон |
zip | Почтовый индекс |
current | Является ли организацией по умолчанию |
Список организаций
Пример запроса
Данный метод поддерживает постраничную выдачу результатов.
Пример ответа в случае успеха
GET /email/organizations
Ответ сервера
Ответ сервера содержит коллекцию организаций. Каждый элемент содержит следующие атрибуты:
Атрибут | Описание |
|---|---|
id | Идентификатор |
name | Название |
address | Адрес |
country | Страна |
city | Город |
phone | Телефон |
zip | Почтовый индекс |
current | Является ли организацией по умолчанию |
Информация об организации
Пример запроса
Пример ответа в случае успеха
GET /email/organizations/:id
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
name | Название |
address | Адрес |
country | Страна |
city | Город |
phone | Телефон |
zip | Почтовый индекс |
current | Является ли организацией по умолчанию |
Организация по умолчанию
Пример запроса
Пример ответа в случае успеха
GET /email/organizations/current
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
name | Название |
address | Адрес |
country | Страна |
city | Город |
phone | Телефон |
zip | Почтовый индекс |
current | Является ли организацией по умолчанию |
Задать организацию по умолчанию
Пример запроса
Пример ответа в случае успеха
PATCH /email/organizations/:id/current
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
name | Название |
address | Адрес |
country | Страна |
city | Город |
phone | Телефон |
zip | Почтовый индекс |
current | Является ли организацией по умолчанию |
Изменение организации
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
PATCH /email/organizations/:id
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
name |
|
|
address |
|
|
country |
|
|
city |
|
|
phone |
|
|
zip |
|
|
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
name | Название |
address | Адрес |
country | Страна |
city | Город |
phone | Телефон |
zip | Почтовый индекс |
current | Является ли организацией по умолчанию |
Удаление организации
Пример запроса
DELETE /email/organizations/:id
Рассылки
Создание рассылки
Пример JSON для запроса
Пример запроса
Пример запроса для создания рассылки с вложениями
Пример ответа в случае успеха
POST /email/campaigns
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
from_email |
| Да |
subject |
| Да |
from_name |
|
|
text |
| Должен присутствовать хотя бы один параметр: |
html |
| Должен присутствовать хотя бы один параметр: |
lists | Массив групп получателей | Да |
Элементы массива групп получателей
Параметр | Описание | Обязательный |
|---|---|---|
id | ID группы получателей | Да |
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
from_email | Адрес отправителя |
from_name | Имя отправителя |
html |
|
text |
|
state | Статус |
recipients_count | Количество получателей |
purchase | Информация о тарификации |
statistics | Статистика |
Статусы
Значение | Описание |
|---|---|
draft | Черновик |
pending | На модерации |
delayed | Запланированная |
sending | Отправляется |
canceled | Отменена |
stopped | Остановлена |
completed | Завершена |
archived | В архиве |
Информация о тарификации
Атрибут | Описание |
|---|---|
enable | Может принимать значение true (отправка возможна) или false (недостаточно средств) |
subscribers | Количество подписчиков которое будет списано |
credits | Количество кредитов которое будет списано |
deficit | Количество недостающих средств |
Статистика
Атрибут | Описание |
|---|---|
delivered | Количество доставленных сообщений |
bounced | Количество недоставленный сообщений |
delivering | Количество доставляющихся сообщений |
uniq_open | Количество уникальных открытий |
uniq_click | Количество уникальных переходов |
unsubscription | Количество отписок |
spam | Количество нажатий кнопки "спам" |
Отправка рассылки
Пример запроса
Пример ответа в случае успеха
PATCH /email/campaigns/:id/deliver
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
from_email | Адрес отправителя |
from_name | Имя отправителя |
html |
|
text |
|
state | Статус |
recipients_count | Количество получателей |
purchase | Информация о тарификации |
statistics | Статистика |
Статусы
Значение | Описание |
|---|---|
draft | Черновик |
pending | На модерации |
delayed | Запланированная |
sending | Отправляется |
canceled | Отменена |
stopped | Остановлена |
completed | Завершена |
archived | В архиве |
Информация о тарификации
Атрибут | Описание |
|---|---|
enable | Может принимать значение true (отправка возможна) или false (недостаточно средств) |
subscribers | Количество подписчиков которое будет списано |
credits | Количество кредитов которое будет списано |
deficit | Количество недостающих средств |
Статистика
Атрибут | Описание |
|---|---|
delivered | Количество доставленных сообщений |
bounced | Количество недоставленный сообщений |
delivering | Количество доставляющихся сообщений |
uniq_open | Количество уникальных открытий |
uniq_click | Количество уникальных переходов |
unsubscription | Количество отписок |
spam | Количество нажатий кнопки "спам" |
Информация о рассылке
Пример запроса
Пример ответа в случае успеха
GET /email/campaigns/:id
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
id | Идентификатор |
from_email | Адрес отправителя |
from_name | Имя отправителя |
html |
|
text |
|
state | Статус |
recipients_count | Количество получателей |
purchase | Информация о тарификации |
statistics | Статистика |
Статусы
Значение | Описание |
|---|---|
draft | Черновик |
pending | На модерации |
delayed | Запланированная |
sending | Отправляется |
canceled | Отменена |
stopped | Остановлена |
completed | Завершена |
archived | В архиве |
Информация о тарификации
Атрибут | Описание |
|---|---|
enable | Может принимать значение true (отправка возможна) или false (недостаточно средств) |
subscribers | Количество подписчиков которое будет списано |
credits | Количество кредитов которое будет списано |
deficit | Количество недостающих средств |
Статистика
Атрибут | Описание |
|---|---|
delivered | Количество доставленных сообщений |
bounced | Количество недоставленный сообщений |
delivering | Количество доставляющихся сообщений |
uniq_open | Количество уникальных открытий |
uniq_click | Количество уникальных переходов |
unsubscription | Количество отписок |
spam | Количество нажатий кнопки "спам" |
Webhooks
Данный механизм позволяют получать POST запросы на указанный URL, когда происходят события, связанные с одиночными сообщениями.
Структура сообщений, отправляемых на указанный URL:
Ключ message содержит информацию о сообщении, с которым связано событие. Ключ event содержит информацию о событии. На данный момент ключ data возвращается только для события clicked, и содержит адрес ссылки, по которой кликнули.
Виды событий
Событие | Описание |
|---|---|
delivered | Сообщение доставлено |
opened | Сообщение открыто |
clicked | Получатель перешел по ссылке. Ключ event.data содержит URL ссылки |
unsubscribed | Получатель отписался |
complined | Получатель пожаловался на спам |
skipped | Сообщение не было отправлено (возможные причины: получатель ранее отписался или пожаловался на спам) |
soft_bounced | Сообщение не принято почтовым сервером получателя (возможно, будет принято позже) |
hard_bounced | Сообщение не принято почтовым сервером получателя |
Установка webhook
Пример JSON для запроса
Пример запроса
Пример ответа в случае успеха
POST /email/webhook
Параметры запроса
Параметр | Описание | Обязательный |
|---|---|---|
url | URL, на который отправлять данные о событии | Да |
Ответ сервера
Ответ сервера содержит JSON со следующими атрибутами:
Атрибут | Описание |
|---|---|
url | URL, на который отправлять данные о событии |
Получение информации о webhook
Пример запроса
Пример ответа в случае успеха
GET /email/webhook
Удаление webhook
Пример JSON для запроса
Пример запроса
DELETE /email/webhook
SMTP
Базовый URL
Адрес: smtp.msndr.net
Порт: 25
Аутентификация
Имя пользователя: email вашего аккаунта
Пароль: API ключ
Пример SMTP сессии
В случае отправки сообщений ответ будет содержать строку с информацией об отправленных письмах.
Строка содержит адреса получателей и ID сообщений в формате <email:id>, объединенные запятой (см. пример выше).