Получение списка подписчиков
URL интерфейса: http://api.massdelivery.ru/subscribers.html?action=list
id | ID подписчиков для вывода. Если не передан будут отображены все подписчики. |
sortorder | Cортировка для результата:
|
sortorderdir | Направление сортировки:
|
records_on_page | Кол-во записей в результате запроса. |
page | Постраничная навигация. |
search | Критерии фильтра поиска. Необходимо указывать search [ нужный критерий ] 1. date_from и date_to - дата добавления подписчика в ваш список. Формат даты: д/м/гггг 2. email - Email-адреc подписчика 3. email_state - статус email-адреса. (active - активный, activation - активирующийся, disabled - несуществующий, fbl - спам) 4. name_first - имя подписчика 5. name_last - фамилия подписчика 6. name_mid - отчество подписчика 7. birth_day, birth_month и birth_year - день, месяц и год рождения подписчика 8. country_id - страна подписчика 9. city - город подписчика 10. address - адрес подписчика 11. sex - пол подписчика: (m - мужчина, w - женщина) 12. phones - любые контактные данные подписчика 13. deliveries_ids - рассылки на которые подписан подписчик 14. queue - статус получения писем рассылки (0 - свободные от получения писем, 1 - в процессе получения) 13. groups_ids - группы в которые включен подписчик |
search[name_first]=/^имя$/
- где знак ^
означает что в результате поиска будут отображены подписчики у которых name_first начинается с "имя", а знак $
- все значения заканчиваются на "имя".
Также необходимо добавить /
в начале и конце значения критерия.
{ "result":1, "list":{ "count":1, "pages":1, "records_on_page":100, "page":0, "elements":[ { "id":"1", "date_added":"24\/04\/2017 10:16:19", "state":"active", "email":"email@email.com", "name_first":"My Name", "name_mid":"", "name_last":"", "sex":"m", "country_id":"1", "city":"New York", "address":"", "phones":"", "birth_year":"", "birth_month":"", "birth_day":"", "extra_fields":[ { "id":"s1", "value":"none" } ], "deliveries":[ { "id":"1", "date_added":"25.05.2017 11:30:09" } ], "groups":[ { "id":"1", "date_added":"25.05.2017 11:35:09" } ], } ] } }
list | Cписок записей. |
list/count | Количество записей в результате. Если список пуст, то count будет равен 0. |
list/pages | Количество страниц в результате. |
list/records_on_page | Количество записей на одной странице. |
list/page | Текущая страница. Отсчет страниц происходит с нуля. |
list/element | Описание подписчика. |
element/id | ID подпичсика. |
element/date_added | Дата добавления подписчика (д/м/г ч:м:с +02GMT). |
element/state | Состояние подписчика:
|
element/email | Email-адрес подписчика. |
element/first_name | Имя подписчика. |
element/middle_name | Отчество подписчика. |
element/last_name | Фамилия подпичсика. |
element/sex | Пол подписчика
|
element/country_id | ID страны подписчика. |
element/city | Город подписчика. |
element/address | Адрес подписчика. |
element/phones | Любые контактные данные подписчика. |
element/birth_year | Год рождения подписчика. |
element/birth_month | Месяц рождения подписчика. |
element/birth_day | День рождения подписчика. |
element/extra_fields | Дополнительные данные подписчика из раздела "Доп. данные подписчиков" аккаунта автора. |
extra_fields/id | ID дополнительного поля. |
extra_fields/value | Значение дополнительного поля. |
element/deliveries | Список рассылок, на которые подписан подписчик. |
delivery/id | ID рассылки. |
delivery/date_added | Дата подписки на рассылку. |
element/groups | Список групп, в которые включен подписчик. |
group/id | ID группы. |
group/date_added | Дата включения в группу. |