Методы ресурса Sends

Метод:index

url: /mailer/sends

http-method: GET

Используется для получения списка рассылок пользователя.

Опциональные параметры

fields - значения по умолчанию: ["id","letter_title"]. Список доступных полей: id, maket_id, count, date, status, sender_email_id, included_lists, excluded_lists, letter_title. Если переданы неправильные параметры, вернётся значение по умолчанию.
filter - доступные поля: maket_id, count, status, date (строка, содержащая массив полей: start_date (type: timestamp) - начальная дата фильтрации, end_date (type: timestamp) - конечная дата фильтрации).
sort_field - значение по умолчанию: id. Доступные поля для сортировки: id, date.

Структура ответа

HTTP status code: 200.

При успешном выполнении запроса метод возвращает запрашиваемые данные в формате json.

Пример успешного ответа:

{
  "sends": [
    {
      "id": 1,
      "maket_id": 1,
      "count": 1,
      "date": 1475169822,
      "included_lists": [
        19
      ],
      "excluded_lists": [
        
      ],
      "status": 0,
      "sender_email_id": 5,
      "letter_title": "letter_title"
    },
    {
      "id": 2,
      "maket_id": 13,
      "count": 1,
      "date": 1475173053,
      "included_lists": [
        127
      ],
      "excluded_lists": [
        
      ],
      "status": 0,
      "sender_email_id": 3,
      "letter_title": "letter_title"
    },
    {
     ...
    }
  ]
}
Название параметра Тип Описание
id int Идентификатор рассылки.
maket_id int Идентификатор используемого макета.
count int Количество email адресов, участвующих в рассылке.
status int Состояние рассылки. Статус: 0 - назначена на время; 1 - рассылается; 2 - сбор статистики; 3 - уточнение статистики; 4 - завершена.
included_lists array Массив, содержащий группы подписчиков, участвующие в рассылке.
excluded_lists array Массив, содержащий группы подписчиков, которые исключены из рассылки.
sender_email_id int Идентификатор выбранного email-a отправителя.
date timestamp Дата начала рассылки.
letter_title string Тема письма.

Метод:view

url: /mailer/sends/[id]

http-method: GET

Используется для получения рассылки по уникальному идентификатору (id).

Опциональные параметры

fields - значение по умолчанию: ["id","letter_title"]. Список доступных полей: id, maket_id, count, date, status, sender_email_id, included_lists, excluded_lists, letter_title.

Структура ответа

HTTP status code: 200.

При успешном выполнении запроса метод возвращает запрашиваемые данные в формате json.

Пример успешного ответа:

{
  "id": 1,
  "letter_title": "letter_title",
  "maket_id": 10,
  "count": 1,
  "status": 4,
  "sender_email_id": 2,
  "date": 1474711779,
  "included_lists": [
    1
  ],
  "excluded_lists": [
    
  ]
}
Название параметра Тип Описание
id int Идентификатор рассылки.
maket_id int Идентификатор используемого макета.
count int Количество email адресов, участвующих в рассылке.
status int Состояние рассылки. Статус: 0 - назначена на время; 1 - рассылается; 2 - сбор статистики; 3 - уточнение статистики; 4 - завершена.
included_lists array Массив, содержащий группы подписчиков, участвующие в рассылке.
excluded_lists array Массив, содержащий группы подписчиков, которые исключены из рассылки.
sender_email_id int Идентификатор выбранного email-a отправителя.
date timestamp Дата начала рассылки.
letter_title string Тема письма.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20520 Invalid arguments. Wrong parameters of string fields Переданны неправильные параметры строки fields.
404 Not found Рассылки по переданому идентификатору не найдено.

Метод: add

url: /mailer/sends

http-method: POST

Используется для создания новой рассылки. Здесь можно указать участвующие и неучаствующие группы подписчиков, задать email отправителя, макет и тему рассылаемого письма.

Обязательные параметры

Название Тип Описание
maket_id int Идентификатор используемого макета.
letter_title string Тема письма.
included_lists string Строка в формате json, которая содержит группы подписчиков, по коротым будет проводиться рассылка.

Опциональные параметры

Название Тип Значение по умолчанию Описание
excluded_lists string Строка в формате json, которая содержит группы подписчиков, которые исключены из рассылки.
sender_email_id int Sender email, который установлен по умолчанию в настройках отправителя. Идентификатор email-а отправителя.
date timestamp Текущий timestamp Время начала отправки рассылки.

Структура ответа

HTTP status code: 201.

При успешном выполнении запроса возвращается идентификатор (id) созданной рассылки.

Пример успешного ответа:

{
  "id": 1
}
Название параметра Тип Описание
id int Идентификатор рассылки.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20540 Invalid sender_email_id. Specified sender_email_id did not found Передан идентификатор несуществующего email-а отправителя.
400 20541 You do not have default email. Please add new sender_email У вас нет email-а отправителя по умолчанию. Добавьте новый email отправителя.
400 20542 Invalid maket_id. Specified maket_id did not found Передан идентификатор несуществующего макета.
400 20543 Invalid letter_title. Letter_title can not be empty Тема письма не может быть пустой.
400 20544 Empty included lists Нужно выбрать группы подписчиков, участвующие в рассылке. Поле не может быть пустым.
400 20545 No active emails in selected lists В выбранной группе подписчиков нет пользователей.
400 20546 Processing error. Please contact with support service of Estismail support@estismail.com Ошибка обработки. Пожалуйста обратитесь в нашу службу поддержки Estismail support@estismail.com.
400 20547 Some error with saving letter. Please try again Неудается сохранить письмо для рассылки.
400 20548 Can not save send. Please try again Проблемы с сохранением рассылки.

Метод:delete

url: /mailer/sends/[id]

http-method: DELETE

Удаление рассылки. Удалить можно только рассылки, которые еще не рассылались.

Структура ответа

HTTP status code: 204.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20580 Send in progress now or already sent and it can not be removed Рассылка отправлена или отправляется в данный момент и поэтому не может быть удалена.
404 Not found Рассылки по переданому идентификатору не найдено.