url: /mailer/lists
http-method: GET
Используется для получения списка групп подписчиков.
Название | Тип | Значение по умолчанию | Описание |
---|
Название параметра | Тип | Описание |
---|---|---|
id | int | Идентификатор группы подписчиков. |
title | string | Название группы подписчиков. |
about | string | Краткое описание группы подписчиков. |
status | int | 1 - активна. 0 - заблокирована. -1 - на модерации. - 2 - заблокирована администратором. |
subscribe_page | string | Страница, на которую происходит переадресация после заполнения формы подписки. Если пустая, то используется страница Estismail по умолчанию. |
activate_page | string | Страница, на которую происходит переадресация после перехода на ссылку активации. Если пустая, то используется страница Estismail по умолчанию. |
subscribe_link | string | Страница, с которой подписчик перешел. |
subscribe_maket | string | Тело макета письма после подписки. |
subscribe_maket_title | string | Тема макета письма после подписки. |
activate_maket | string | Тело макета письма после активации. |
activate_maket_title | string | Тема макета письма после активации. |
repeat_date | timestamp | Время последней отправки письма активации. |
use_personal_makets | int | Флаг использования персональных макетов. Если 0 - не использовать персональные макеты. 1 - использовать. Использование персональных макетов ( установлен флаг use_personal_makets = 1 ) возможно лишь в том случае, когда заполнены поля activate_maket_title, activate_maket, subscribe_maket_title and subscribe_maket. |
sender_email_id | int | Email, с которого происходит отправка активационных писем. |
url: /mailer/lists/[id]
http-method: GET
Используется для получения группы подписчиков по уникальному идентификатору (id).
Название | Тип | Значение по умолчанию | Описание |
---|---|---|---|
fields | string | ["id","title"] | Строка в формате json, содержащая массив полей, которые необходимо получить для конкретного подписчика. Список доступных полей: id, title, about, status, subscribe_page, activate_page, repeat_date, subscribe_link, subscribe_maket, subscribe_maket_title, activate_maket, activate_maket_title, use_personal_makets, sender_email_id. |
fields - значение по умолчанию: ["id","title"]. Список доступных полей: id, title, about, status, subscribe_page, activate_page, repeat_date, subscribe_link, subscribe_maket, subscribe_maket_title, activate_maket, activate_maket_title, use_personal_makets, sender_email_id.
HTTP status code: 200.
При успешном выполнении запроса метод возвращает запрашиваемые данные в формате json.
Пример успешного ответа:
{ "id": 1, "title": "title", "about": null, "status": 1, "repeat_date": 1460039585, "use_personal_makets": 0, "subscribe_link": "https:\/\/example.com\/", "subscribe_page": "https:\/\/example.com\/", "activate_page": "https:\/\/example.com\/", "subscribe_maket": "", "subscribe_maket_title": "", "activate_maket": "", "activate_maket_title": "", "sender_email_id": 1 }
Название параметра | Тип | Описание |
---|---|---|
id | int | Идентификатор группы подписчиков. |
title | string | Название группы подписчиков. |
about | string | Краткое описание группы подписчиков. |
status | int | 1 - активна. 0 - заблокирована. -1 - на модерации. - 2 - заблокирована администратором. |
subscribe_page | string | Страница, на которую происходит переадресация после заполнения формы подписки. Если пустая, то используется страница Estismail по умолчанию. |
activate_page | string | Страница, на которую происходит переадресация после перехода на ссылку активации. Если пустая, то используется страница Estismail по умолчанию. |
subscribe_link | string | Страница, с которой подписчик перешел. |
subscribe_maket | string | Тело макета письма после подписки. |
subscribe_maket_title | string | Тема макета письма после подписки. |
activate_maket | string | Тело макета письма после активации. |
activate_maket_title | string | Тема макета письма после активации. |
repeat_date | timestamp | Время последней отправки письма активации. |
use_personal_makets | int | Флаг использования персональных макетов. Если 0 - не использовать персональные макеты. 1 - использовать. Использование персональных макетов ( установлен флаг use_personal_makets = 1 ) возможно лишь в том случае, когда заполнены поля activate_maket_title, activate_maket, subscribe_maket_title and subscribe_maket. |
sender_email_id | int | Email, с которого происходит отправка активационных писем. |
Код ответа | Код ошибки | Текст ответа | Описание |
---|---|---|---|
400 | 20320 | Invalid fields. Wrong parameters of string fields | Переданны неправильные параметры строки fields. |
404 | Not found | Группы подписчиков по переданому идентификатору не найдено. |
url: /mailer/lists
http-method: POST
Используется для создания новой группы подписчиков. Так же с помощью этого метода можно указать собственные страницы, на которые будет происходить переадресация после активации и подписки соответственно, задать email, который будет использоваться для рассылки писем активации и задать флаг использования собственных макетов для приходящих писем после активации и подписки.
Название | Тип | Значение по умолчанию | Описание |
---|---|---|---|
title | string | Название группы подписчиков. | |
subscribe_link | string | Страница, с которой подписчик перешел. |
Название | Тип | Значение по умолчанию | Описание |
---|---|---|---|
about | string | Краткое описание группы подписчиков. | |
subscribe_page | string | http://mailer.estismail.com/ subscribeme |
Страница, на которую происходит переадресация после заполнения формы подписки. Если пустая, то используется страница Estismail по умолчанию. |
activate_page | string | http://mailer.estismail.com/ subscriberactivate |
Страница, на которую происходит переадресация после перехода на ссылку активации. Если пустая, то используется страница Estismail по умолчанию. |
subscribe_maket | string | Тело макета письма после подписки. | |
subscribe_maket_title | string | Тема макета письма после подписки. | |
activate_maket | string | Тело макета письма после активации. | |
activate_maket_title | string | Тема макета письма после активации. | |
use_personal_makets | int | Флаг использования персональных макетов. Если 0 - не использовать персональные макеты. 1 - использовать. Использование персональных макетов ( установлен флаг use_personal_makets = 1 ) возможно лишь в том случае, когда заполнены поля activate_maket_title, activate_maket, subscribe_maket_title and subscribe_maket. | |
sender_email_id | int | Email, с которого происходит отправка активационных писем. |
HTTP status code: 201.
При успешном выполнении запроса возвращается идентификатор (id) созданной группы подписчиков.
Пример успешного ответа:
{ "id": 1 }
Название параметра | Тип | Описание |
---|---|---|
id | int | Идентификатор группы подписчиков. |
Код ответа | Код ошибки | Текст ответа | Описание |
---|---|---|---|
400 | 20340 | Invalid title. Title can not be empty | Заглавие группы подписчиков не может быть пустым. |
400 | 20341 | Invalid subscribe_link. URL must be existing | Ссылка не может быть пуста и должна быть существующая. |
400 | 20342 | You can use personal makets, only when activate_maket_title, activate_maket, subscribe_maket_title and subscribe_maket are not empty | Использование персональных макетов ( установлен флаг use_personal_makets = 1 ) возможно лишь в том случае, когда заполнены поля activate_maket_title, activate_maket, subscribe_maket_title and subscribe_maket. |
url: /mailer/lists/[id]
http-method: PUT
Используется для редактирования группы подписчиков. Так же с помощью этого метода можно изменить собственные страницы, на которые будет происходить переадресация после активации и подписки соответственно, изменить email, который будет использоваться для рассылки писем активации и изменить флаг использования собственных макетов для приходящих писем после активации и подписки.
Название | Тип | Значение по умолчанию | Описание |
---|---|---|---|
title | string | Название группы подписчиков. | |
subscribe_link | string | Страница, с которой подписчик перешел. | |
status | int | Смена статуса. Возможно только активировать группу - передать 1. | |
about | string | Краткое описание группы подписчиков. | |
subscribe_page | string | http://mailer.estismail.com/ subscribeme |
Страница, на которую происходит переадресация после заполнения формы подписки. Если пустая, то используется страница Estismail по умолчанию. |
activate_page | string | http://mailer.estismail.com/ subscriberactivate |
Страница, на которую происходит переадресация после перехода на ссылку активации. Если пустая, то используется страница Estismail по умолчанию. |
subscribe_maket | string | Тело макета письма после подписки. | |
subscribe_maket_title | string | Тема макета письма после подписки. | |
activate_maket | string | Тело макета письма после активации. | |
activate_maket_title | string | Тема макета письма после активации. | |
use_personal_makets | int | Флаг использования персональных макетов. Если 0 - не использовать персональные макеты. 1 - использовать. Использование персональных макетов ( установлен флаг use_personal_makets = 1 ) возможно лишь в том случае, когда заполнены поля activate_maket_title, activate_maket, subscribe_maket_title and subscribe_maket. | |
sender_email_id | int | Email, с которого происходит отправка активационных писем. |
HTTP status code: 204.
Код ответа | Код ошибки | Текст ответа | Описание |
---|---|---|---|
400 | 20360 | Invalid title. Title can not be empty | Название группы подписчиков не может быть пустым. |
400 | 20361 | Invalid subscribe_link. URL must be existing | Ссылка не может быть пуста и должна быть валидна. |
400 | 20362 | You can use personal makets, only when activate_maket_title, activate_maket, subscribe_maket_title and subscribe_maket are not empty | Использование персональных макетов ( установлен флаг use_personal_makets = 1 ) возможно лишь в том случае, когда заполнены поля activate_maket_title, activate_maket, subscribe_maket_title and subscribe_maket. |
404 | Not Found | Группы подписчиков по переданому идентификатору не найдено. |
url: /mailer/lists/[id]
http-method: DELETE
Удаление группы подписчиков.
HTTP status code: 204.
Код ответа | Текст ответа | Описание |
---|---|---|
404 | Not found | Группы подписчиков по переданому идентификатору не найдено. |