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

Метод:index

url: /mailer/emails

http-method: GET

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

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

Название Тип Значение по умолчанию Описание
list_id int Идентификатор группы подписчиков, по которой необходимо получить список подписчиков. Если этот идентификатор отсутствует, вернётся список подписчиков.

fields - значения по умолчанию: ["id","email"]. Список доступных полей: id, name, email, city, phone, date, status, ip, skype, subscribe_link. Если переданы неправильные параметры, вернётся значение по умолчанию.
filter - доступные поля: email, status, date (строка, содержащая массив полей: start_date (type: timestamp) - начальная дата фильтрации, end_date (type: timestamp) - конечная дата фильтрации).
sort_field - значение по умолчанию: id. Доступные поля для сортировки: id, email, status, date.

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

HTTP status code: 200.

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

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

{
  "emails": [
    {
      "id": 1,
      "name": "name1",
      "email": "example@example.com",
      "city": "",
      "phone": "",
      "date": 1475067337,
      "ip": "92.205.206.85",
      "skype": "skype_login",
      "subscribe_link": null,
      "status": 0
    },
    {
      "id": 2,
      "name": "name2",
      "email": "name2@example.com",
      "city": "",
      "phone": "",
      "date": 1475135242,
      "ip": "92.205.206.85",
      "skype": "skype_login",
      "subscribe_link": "http:\/\/example.com",
      "status": 0
    },
    {
    ...
    }
  ]
}
Название параметра Тип Описание
id int Идентификатор подписчика.
name string Имя подписчика.
email string Email адрес подписчика.
city string Город проживания подписчика.
phone string Номер телефона подписчика.
date timestamp Дата подписки.
status int 0 - активный подписчик. 1 - подписчик блокирован. 2 - подписчик отписался от рассылки. 3 - не подтвердил подписку.
ip string IP адрес подписчика.
skype string Аккаунт скайпа подписчика.
subscribe_link string Ссылка подписки.

Метод:view

url: /mailer/emails/[id]

http-method: GET

Используется для получения информации подписчика по уникальному идентификатору (id). Если указана группа подписчиков (list_id), выборка будет проводится только из указанной группы подписчиков.

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

Название Тип Значение по умолчанию Описание
list_id int Идентификатор группы подписчиков, по которой необходимо получить список подписчиков.

fields - значение по умолчанию: ["id","email"]. Список доступных полей: id, name, email, city, phone, date, status, ip, skype, subscribe_link.

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

HTTP status code: 200.

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

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

{
  "id": 1,
  "name": "name",
  "email": "example@example.com",
  "city": "Kiev",
  "phone": "",
  "date": 1475067337,
  "ip": "92.205.206.85",
  "skype": "skype_login",
  "status": 0,
  "subscribe_link": "http:\/\/example.com"
}
Название параметра Тип Описание
id int Идентификатор подписчика.
name string Имя подписчика.
email string Email адрес подписчика.
city string Город проживания подписчика.
phone string Номер телефона подписчика.
date timestamp Дата подписки.
status int 0 - активный подписчик. 1 - подписчик блокирован. 2 - подписчик отписался от рассылки. 3 - не подтвердил подписку.
ip string IP адрес подписчика.
skype string Аккаунт скайпа подписчика.
subscribe_link string Ссылка подписки.

Ошибки

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

Метод: add

url: /mailer/emails

http-method: POST

Используется для добавления нового подписчика в определённую группу подписчиков по идентификатору list_id. Так же можно внести ссылку подписки, IP-адрес и флаг отправки активационного письма.

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

Название Тип Описание
email string Email нового подписчика.
list_id int Идентификатор группы подписчиков, в которую добавляется новый подписчик.

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

Название Тип Значение по умолчанию Описание
name string Имя подписчика.
city string Город проживания.
phone string Номер телефона.
skype string Аккаунт скайпа.
subscribe_link string Ссылка подписки.
ip string IP - адрес подписчика.
form_id int Идентификатор формы подписки.
activation_letter int 1 Флаг отправки письма активации подписки. 1 - отправлять. 0 - не отправлять. Если передан флаг 0, то подписчик будет сразу активным.

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

HTTP status code: 201.

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

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

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

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20140 Invalid email. Check the validity of the specified email Email не может быть пустым и должен быть валидным.
400 20141 Invalid list_id. List with specified id does not exist Передан несуществующий list_id. Группы подписчиков с таким list_id не существует.
400 20142 This email is already subscribed Передаваемый email уже есть в выбранной группе подписчиков.

Метод: edit

url: /mailer/emails/[id]

http-method: PUT

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

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

Название Тип Значение по умолчанию Описание
name string Новое имя подписчика.
city string Новой город подписчика.
phone string Новой номер телефона.
skype string Новой аккаунт скайпа.

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

HTTP status code: 204.

Ошибки

Код ответа Код ошибки Текст ответа Описание
400 20160 Arguments are empty Не было передано ни одного параметра для изменения.
404 Not Found Подписчика по переданому идентификатору не найдено.

Метод:delete

url: /mailer/emails/[id]

http-method: DELETE

Удаление подписчика. Если указан идентификатор группы подписчиков list_id, подписчик будет удалён только из заданой группы подписчиков. Если list_id пуст, подписчик будет удален из списка подписчиков.

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

Название Тип Значение по умолчанию Описание
list_id int Идентификатор группы подписчиков. Если указан этот параметр - будет подписчик удалён только с указанной группы. Если этот параметр не задан - подписчик будет удалён из общей группы подписчиков.

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

HTTP status code: 204.

Ошибки

Код ответа Код ошибки Текст ответа Описание
404 Not found Подписчика по переданому идентификатору не найдено.