Удалить группу
Вызов
deleteGroup
Входные параметры
project_id | Идентификатор проекта из которого необходимо удалить группу |
---|---|
group_id | Идентификатор группы которую необходимо удалить |
Результат возврата
Если операция прошла успешна, возвращается «Done»
Реализация
Пример:
//пример на JSON
Результат:
//Вывод на JSON
Пример:
//пример на PHP
Результат:
//Вывод на PHP
Удалить фильтр
Текст статьи будет вскоре размещен.Получить общую информацию о подписчиках
Вызов
getInfoSubscribers
Входные параметры
project_id | Идентификатор проекта в котором необходимо получить общую информацию о подписчиках |
---|
Результат возврата
Массив:
total | Общее количество подписчиков |
---|---|
emails | Количество подписчиков с email-адресом |
phone_numbers | Количество подписчиков с номером телефона |
emails_unsubscribed | Количество подписчиков которые отписались от email-рассылок |
emails_abuse | Количество подписчиков которые отписались от email-рассылок и пожаловались на СПАМ |
emails_check | Количество подписчиков email-адрес которых проверяется администратором |
emails_ok | Количество подписчиков email-адрес которых доступен для рассылок |
emails_disabled_user | Количество подписчиков email-адрес которых отключен пользователем |
date | Дата и время последнего добавленного подписчика |
Реализация
Пример:
//пример на JSON
Результат:
//Вывод на JSON
Пример:
//пример на PHP
Результат:
//Вывод на PHP
Получение списка полей базы для проекта
Вызов
getBaseStructure
Входные параметры
project_id | ID проекта, для которого необходимо получить список полей |
---|
Результат возврата
Массив:
name | Название поля |
---|---|
id | Идентификатор поля |
type | Тип поля |
Реализация
Пример:
//пример на JSON
Результат:
//Вывод на JSON
Пример:
//пример на PHP
Результат:
Array
(
[0] => Array
(
[name] => "Электронный адрес"
[id] => 1
[type] => "email"
)
[1] => Array
(
[name] => "Номер телефона"
[id] => 2
[type] => "phone_number"
)
[2] => Array
(
[name] => "Имя"
[id] => 3
[type] => "text"
)
}
Получить список фильтров
Вызов
getFilters
Входные параметры
project_id | Идентификатор проекта из которого необходимо получить список фильтров |
---|---|
filters_keyword необязательный |
Строка для поиска фильтров |
Результат возврата
Массив:
id | Идентификатор фильтра |
---|---|
name | Название фильтра |
Реализация
Пример:
//пример на JSON
Результат:
//Вывод на JSON
Пример:
//пример на PHP
Результат:
Array
(
[0] => Array
(
[id] => 290
[name] => "Фильтр 1"
)
[1] => Array
(
[id] => 293
[name] => "Фильтр 2"
)
)
Получение списка пользователей по телефону или по его части
Текст статьи будет вскоре размещен.Получение списка пользователей по email или по его части
Текст статьи будет вскоре размещен.Добавить подписчика
Вызов
addSubscriber
Входные параметры
project_id | Идентификатор проекта в который необходимо добавить подписчика |
---|---|
subscriber | Массив с данными подписчика |
Массив «subscriber» должен содержать следующие значения: | |
data | Массив с идентификаторами полей в базе и данными о добавляемом подписчике. data [id поля базы]= значение |
---|---|
groups_add | Массив c идентификаторами групп в которые необходимо добавить подписчика |
Результат возврата
Если операция прошла успешна, возвращается идентификатор подписчика
Реализация
Пример:
//пример на JSON
Результат:
//Вывод на JSON
Пример:
//пример на PHP
Результат:
//Вывод на PHP
Редактирование подписчика
Вызов
editSubscriber
Входные параметры
project_id | Идентификатор проекта в котором необходимо отредактировать подписчика |
---|---|
subscriber | Массив с новыми данными подписчика |
Массив «subscriber» должен содержать следующие значения: | |
data | Массив с идентификаторами полей в базе и новыми данными подписчика. data [id поля базы]= значение |
---|---|
groups_add | Массив c идентификаторами групп в которые необходимо добавить подписчика |
groups_delete | Массив c идентификаторами групп из которых необходимо удалить подписчика |
Результат возврата
Если операция прошла успешна, возвращается «Done»
Реализация
Пример:
//пример на JSON
Результат:
//Вывод на JSON
Пример:
//пример на PHP
Результат:
//Вывод на PHP
Удаление подписчика
Вызов
deleteSubscriber
Входные параметры
project_id | Идентификатор проекта из которого необходимо удалить подписчика |
---|---|
subscriber_id | Идентификатор подписчика которого необходимо удалить |
Результат возврата
Если операция прошла успешна, возвращается «Done»
Реализация
Пример:
//пример на JSON
Результат:
//Вывод на JSON
Пример:
//пример на PHP
Результат:
//Вывод на PHP
Получить список групп
Вызов
getGroups
Входные параметры
project_id | Идентификатор проекта из которого необходимо получить список групп |
---|---|
groups_keyword необязательный |
Строка для поиска групп |
Результат возврата
Массив:
id | Идентификатор группы |
---|---|
name | Название группы |
Реализация
Пример:
//пример на JSON
Результат:
//Вывод на JSON
Пример:
//пример на PHP
Результат:
Array
(
[0] => Array
(
[id] => 290
[name] => "Группа 1"
)
[1] => Array
(
[id] => 293
[name] => "Группа 2"
)
)
Создать новую группу
Вызов
createGroup
Входные параметры
project_id | Идентификатор проекта в котором необходимо создать группу |
---|---|
group_name | Название группы |
Результат возврата
Если операция прошла успешна, возвращается идентификатор группы
Возможные ошибки:
ERROR_IN_NAME | В названии группы есть запрещенные символы |
---|---|
ERROR_ALREADY_EXIST | Группа с данным названием уже существует в системе |
Реализация
Пример:
//пример на JSON
Результат:
//Вывод на JSON
Пример:
//пример на PHP
Результат:
Array
(
[ID] => 394
)
Получить всех подписчиков (экспорт)
Вызов
addSubscriber
Входные параметры
project_id | Идентификатор проекта в который необходимо добавить подписчика |
---|---|
subscriber | Массив с данными подписчика |
Массив «subscriber» должен содержать следующие значения: | |
data | Массив с идентификаторами полей в базе и данными о добавляемом подписчике. data [id поля базы]= значение |
---|---|
groups_add | Массив c идентификаторами групп в которые необходимо добавить подписчика |
Результат возврата
Если операция прошла успешна, возвращается идентификатор подписчика
Реализация
Пример:
//пример на JSON
Результат:
//Вывод на JSON
Пример:
//пример на PHP
Результат:
//Вывод на PHP
Последнее обновление 28.12.2018
- Удалить группу
- Удалить фильтр
- Получить общую информацию о подписчиках
- Получение списка полей базы для проекта
- Получить список фильтров
- Получение списка пользователей по телефону или по его части
- Получение списка пользователей по email или по его части
- Добавить подписчика
- Редактирование подписчика
- Удаление подписчика
- Получить список групп
- Создать новую группу
- Получить всех подписчиков (экспорт)