Campaigns.Get
Описание
Запросить кампании пользователя.
Параметры запроса
- SessionID = {string} (обязательный)
- Session ID необходим для аутентификации. Обязателен только для десктоп приложений
- Command = {Campaigns.Get} (обязательный)
- API команда
- ResponseFormat = {JSON | XML} (обязательный)
- Формат ответа
- JSONPCallBack = {bool}
- Используется для междоменной передачи. Узнать о JSONP можно по ссылке: http://ru.wikipedia.org/wiki/JSONP
- OrderField = {string} (обязательный)
- Название поля по которому будет производиться сортировка
- OrderType = {ASC | DESC} (обязательный)
- Возрастающая или убывающая сортировка
- CampaignStatus = {All | Draft | Ready | Sending | Paused | Pending Approval | Sent | Failed} (обязательный)
- Статус кампаний для запроса
- SearchKeyowrd = {string} (обязательный)
- Слово для поиска по имени кампании
- RecordsPerRequest = {integer} (обязательный)
- Сколько строк для возврата на страницу
- RecordsFrom = {integer} (обязательный)
- Начать с (начинается с нуля)
- RetrieveTags = {true|false}
- Установите true если сортируете список кампаний специальными фильтрами
- Tags = {string} (v4.0.4+)
- Номера ID тегов, разделенные запятой, если хотите отфильтровать список кампаний по тегам
Параметры ответа
- Success = {true | false}
- Состояние - успешно или ошибка
- ErrorCode = {integer}
- Код ошибки
- ErrorText = {text}
-
- Campaigns = {array}
- Возвращает весь список кампаний в массиве
- TotalCampaigns = {integer}
- Возвращает общее количество кампаний
Коды ошибок
- 1
- Укзанный ID пользователя не найден
- 99998
- Ошибка авторизации или истекла сессия
- 99999
- Недостаточно прав
