Subscribers.Get

Описание

Извлекает подписчиков списка подписчиков.

Параметры запроса

SessionID = {string} (обязательный)
Session ID необходим для аутентификации. Обязателен только для десктоп приложений
Command = {Subscribers.Get} (обязательный)
API команда
ResponseFormat = {JSON | XML} (обязательный)
Формат ответа
JSONPCallBack = {bool}
Используется для междоменной передачи. Узнать о JSONP можно по ссылке: http://ru.wikipedia.org/wiki/JSONP
OrderField = {string} (обязательный)
Название поля для сортировки
OrderType = {ASC | DESC} (обязательный)
Восходящий или нисходящий порядок сортировки
RecordsFrom = {integer} (обязательный)
Начать с ... (начиная с нуля)
RecordsPerRequest = {integer} (обязательный)
Сколько строк для возврата на страницу
SearchField = {string} (обязательный)
Дополнительное поля для поиска. Оставьте пустым, чтобы отключить поиск
SearchKeyword = {string} (обязательный)
Запорс для поиска. Оставьте пустым, чтобы отключить поиск
SubscriberListID = {integer} (обязательный)
ID списка
SubscriberSegment = {mixed} (обязательный)
ID целевого сегмента или одно из следующих значений: Suppressed, Unsubscribed, Soft bounced, Hard bounced, Opt-in pending, Active.

Параметры ответа

Success = {true | false}
Состояние - успешно или ошибка
ErrorCode = {integer}
Код ошибки
ErrorText = {text}
Subscribers = {array}
Возвращает список всех подписчиков в массиве
TotalSubscribers = {integer}
Возвращает общее количество подписчиков

Коды ошибок

1
Не найден ID списка
2
ID целевого сегмента не найден
99998
Ошибка авторизации или истекла сессия
99999
Недостаточно прав