Метод для получения перечня всех имеющихся рассылок. Количество получаемых за раз рассылок ограничено числом 10000. Для получения полного списка рассылок при их количестве более 10000, используйте параметры from и to.
Принцип использования
| Синтаксис и URL для вызова метода |
| getCampaigns (datetime from, datetime to) |
https://api.unisender.com/ru/api/getCampaigns?format=json&api_key=KEY&from=TIME&to=TIME
|
| Аргументы |
| api_key * |
Ключ доступа к API. |
| from |
Дата и время старта рассылки, начиная с которой нужно выводить рассылки, в формате «ГГГГ-ММ-ДД чч:мм:сс», часовой пояс UTC. |
| to |
Дата и время старта рассылки, заканчивая которой нужно выводить рассылки, в формате «ГГГГ-ММ-ДД чч:мм:сс», часовой пояс UTC. |
| limit |
Количество записей в ответе на один запрос должно быть целым числом в диапазоне 1 — 10 000. |
| offset |
Параметр указывает, с какой позиции начинать выборку. Значение должно быть 0, или больше (позиция первой записи начинается с 0), по умолчанию 0. |
| Возвращаемое значение |
| JSON-массив, каждый элемент массива – объект с полями: |
| id |
Id текущей рассылки. |
| start_time |
Время старта рассылки, возвращается в формате «ГГГГ-ММ-ДД чч:мм:сс» в UTC. |
| status |
Текущий статус рассылки. Подробное описание возможных статусов рассылок приведено в методе getCampaignStatus. |
| message_id |
Id сообщения, передаваемого в данной рассылке. |
| list_id |
Id списка, для которого создавалась рассылка. |
| subject |
Тема письма рассылки. |
| sender_name |
Значение поля "От кого" в данной рассылке. |
| sender_email |
Значение поля "С адреса" в данной рассылке. |
| stats_url |
URL страницы отчета по данной рассылке. |
Пример возвращаемого значения:
{
"result": [
{
"id": 6626556,
"start_time": "2015-09-28 10:03:59",
"status": "waits_schedule",
"message_id": 3769465,
"list_id": 32127465,
"subject": ", спецпредложения туроператоров и
горящие туры",
"sender_name": "test",
"sender_email": "admin-test@unisender.com",
"stats_url": "https://unisender.local/ru/v5/bursts/view/6626556"
},
...
]
}
|
