Справочник по методам API

Pushwoosh предоставляет обширную библиотеку из более чем 100 методов API, сгруппированных по различным функциям, таким как отправка уведомлений, управление пользователями и отслеживание аналитики.

Messaging API v2

Унифицированный API, заменяющий все семейство методов /create*Message (push, email, SMS, Kakao). См. обзор и руководство по миграции.

Notify	Создает и отправляет одно сообщение через любой канал. Заменяет /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage.
Cancel	Отменяет ранее созданное сообщение до его доставки. Используется с message_code из Notify.
Update	Заменяет запланированное сообщение новым определением (полная замена). Используется с message_code из Notify.

SMTP-шлюз

Отправляйте транзакционные email-сообщения по стандартному протоколу SMTP вместо прямого вызова API. Шлюз аутентифицируется с помощью кода вашего приложения и токена API, а затем пересылает каждое сообщение в Notify. См. справочник по SMTP-шлюзу.

Messages API

createMessage Устарел	Создает новое push-уведомление. Вместо него используйте Notify.
deleteMessage	Удаляет сообщение (отправленное или запланированное) и убирает его из истории сообщений.
getMessageDetails	Получает детали сообщения.
createTargetedMessage Устарел	Создает новое таргетированное push-уведомление. Вместо него используйте Notify с типом transactional.
getPushHistory Устарел	Используйте /messages:list для получения истории сообщений с подробными данными.
cancelMessage	Отменяет запланированное сообщение, оставляя его в истории сообщений.

API пресетов

Create	Создает новый пресет для push-уведомлений.
List	Выводит список пресетов для push-уведомлений приложения.
Get	Получает один пресет для push-уведомлений по коду.
Update	Перезаписывает пресет для push-уведомлений по коду.
UpdatePartial	Обновляет только указанные поля пресета для push-уведомлений по коду.
Clone	Дублирует пресет для push-уведомлений в том же приложении.
Delete	Удаляет пресет для push-уведомлений по коду.

Device API

registerDevice	Регистрирует устройство для приложения.
unregisterDevice	Удаляет push-токен устройства.
deleteDevice	Удаляет устройство и все связанные с ним данные в указанном приложении.
setTags	Устанавливает значения тегов для устройства.
getTags	Получает теги с их соответствующими значениями для определенного устройства.
setBadge	Отправляет текущее значение бейджа для устройства в Pushwoosh.
applicationOpen	Регистрирует событие открытия приложения.
pushStat	Регистрирует событие открытия push-уведомления.
messageDeliveryEvent	Регистрирует событие доставки push-уведомления для устройства.

Audience API

bulkSetTags	Устанавливает значения тегов для нескольких устройств.
bulkSetTags Status	Возвращает статус операции bulkSetTags.
bulkRegisterDevice	Регистрирует несколько устройств в одном запросе, включая необязательные значения тегов для каждого устройства.
bulkRegisterDevice Status	Получает статус и результаты запроса на массовую регистрацию устройств по ID запроса.
bulkUnregisterDevice	Отменяет регистрацию нескольких устройств в одном запросе.
bulkUnregisterDevice Status	Получает статус и результаты запроса на массовую отмену регистрации устройств по ID запроса.

API тегов

addTag	Создает тег в вашем аккаунте.
deleteTag	Удаляет тег со всей связанной информацией.
listTags	Получает список тегов в аккаунте.

API сегментации (фильтров)

createFilter	Создает новый сегмент.
listFilters	Возвращает список доступных сегментов с их условиями.
deleteFilter	Удаляет существующий сегмент.
exportSegment	Планирует запрос на экспорт подписчиков, соответствующих условиям сегмента.
exportSegment Results	Получает ссылку на CSV-файл с результатами exportSegment.

API, ориентированный на пользователя

registerUser	Связывает внешний User ID с указанным устройством.
deleteUser	Удаляет пользователя и все устройства, связанные с указанным User ID.
postEvent	Вызывает событие в приложении.

API событий

createEvent	Создает событие для приложения.

API приложений

createApplication	Создает новое приложение в аккаунте.
updateApplication	Обновляет настройки приложения.
deleteApplication	Удаляет приложение из аккаунта.
getApplication	Получает подробную информацию о приложении.
getApplications	Получает список приложений в аккаунте.
getApplicationFile	Получает файлы конфигурации, связанные с приложением.
setApplicationPlatformStatus	Изменяет статус платформы приложения.

API контрольных групп

List	Выводит список контрольных групп приложения.
Create	Создает контрольную группу.
Get	Получает одну контрольную группу по коду.
UpdatePercentage	Изменяет процент удержания в контрольной группе.
UpdateCountries	Ограничивает контрольную группу набором стран.
Disable	Отключает контрольную группу.
Reshuffle	Переформировывает выборку удержания контрольной группы.
ForceUpdateCalculation	Запускает новый подсчет размера контрольной группы.
GetCalculationStatus	Опрашивает статус выполняющегося подсчета размера.
GetAnalytics	Получает аналитику ‘Контроль-vs-Воздействие’ для контрольной группы.
CheckControlGroupMembership	Сообщает, удерживается ли каждый из пакета User ID контрольной группой.
Delete	Удаляет контрольную группу.

API стирания данных

Create	Запускает стирание (или подсчет в тестовом режиме) персональных данных субъекта.
Upload	Создает задачу стирания на основе загруженного CSV-файла с идентификаторами.
ListTasks	Выводит список задач стирания аккаунта.
GetTask	Получает статус и счетчики одной задачи стирания.
ListTaskRows	Выводит результаты одной задачи по каждому идентификатору.
GetTaskReport	Скачивает отчет по одной задаче в формате CSV.
GetJournalReport	Скачивает все задачи за период одним CSV-файлом.

API кампаний

createCampaign	Создает новую push-кампанию.
deleteCampaign	Удаляет определенную кампанию.
getCampaigns	Получает список кампаний для приложения.

API конфигурации приложения

configureApplication for iOS	Настраивает платформу iOS для приложения.
configureApplication for Android	Настраивает платформу Android для приложения.
configureApplication for Mac OS X	Настраивает платформу macOS для приложения.
configureApplication for Windows	Настраивает платформу Windows для приложения.
configureApplication for Amazon	Настраивает платформу Amazon для приложения.
configureApplication for Chrome	Настраивает платформу Chrome для приложения.
configureApplication for Safari	Настраивает платформу Safari для приложения.
configureApplication for Firefox	Настраивает платформу Firefox для приложения.
configureApplication for Email	Настраивает платформу Email для приложения.

Email API

createEmailMessage Устарел	Создает email-сообщение. Вместо него используйте Notify с platforms: ["EMAIL"] и email_payload.
registerEmail	Регистрирует email-адрес для приложения.
deleteEmail	Удаляет email-адрес из вашей базы данных.
setEmailTags	Устанавливает значения тегов для указанного email-адреса.
registerEmailUser	Связывает внешний User ID с указанным email-адресом.

API шаблонов email

Create	Создает новый шаблон email в приложении.
List	Выводит список шаблонов email приложения.
Get	Возвращает один шаблон email по коду.
Update	Обновляет существующий шаблон email по коду.
Delete	Удаляет шаблон email и связанный с ним пресет по коду.
Clone	Клонирует шаблон email в целевое приложение.

API тестовых устройств

createTestDevice	Регистрирует тестовое устройство для приложения.
listTestDevices	Получает все тестовые устройства, зарегистрированные для приложения.

API папки входящих сообщений

getInboxMessages	Получает список сообщений из папки ‘Входящие’ для указанного HWID.
inboxStatus	Обновляет статус определенного сообщения в папке ‘Входящие’.

API статистики

Статистика сообщений

messages:list	Получает список отправленных сообщений.
totalsByIntervals	Предоставляет метрики и данные о конверсиях, агрегированные по часам.
getDeliveryFunnel	Возвращает воронку доставки одного сообщения, с разбивкой по каналу и платформе.
getCampaignDeliveryFunnel	Суммирует воронку доставки по сообщениям кампании.
getMessageLog	Получает подробную информацию об отправленных сообщениях.
linksInteractions	Предоставляет статистику по кликам на ссылки в email.
linksInteractionsDevices	Выводит список пользователей, которые кликнули на ссылки в email.
bouncedEmails	Предоставляет информацию о возвратах email, жалобах и причинах возврата.

Асинхронный экспорт статистики сообщений

exportMessagesStatistics/export	Ставит в очередь экспорт истории сообщений в CSV-файл без ограничений по количеству строк, как в messages:list.
exportMessagesStatistics/status	Возвращает прогресс выполнения задачи экспорта.
exportMessagesStatistics/result	Возвращает имя сгенерированного файла после завершения задачи.
exportMessagesStatistics/lastTasks	Выводит список последних задач экспорта для приложения.
exportMessagesStatistics/delete	Удаляет задачу и ее файл до истечения срока хранения.
exportMessagesStatistics/download	Загружает сгенерированный CSV-файл по имени.

Статистика приложений и подписчиков

getApplicationSubscribersStats	Получает статистику подписчиков приложения, сгруппированную по типу устройства.
getAppStats	Получает статистику приложения за определенный период времени.
getSubscribersStatistics	Получает статистику подписчиков за определенный период времени.

Статистика кампаний

getCampaignStats	Получает статистику кампании за определенный период времени.

Статистика событий и тегов

getEventStatistics	Получает количество срабатываний события за определенный период.
getTagStats	Получает статистику для определенного тега.

Статистика In-App

inapps:totals	Получает общие данные о показах, взаимодействиях и ограничении частоты для одной или нескольких in-app кампаний за определенный период.
inapps:timeline	Получает общие данные за период и временной ряд метрик in-app для одной кампании.

iOS Live Activities API

startLiveActivity	Создает новую iOS Live Activity.
updateLiveActivity	Обновляет существующую iOS Live Activity.

Apple Wallet PassKit API

Apple Wallet PassKit API	Справочник по управлению картами Apple Wallet и связанной конфигурацией в Pushwoosh.

Google Wallet API

Create a pass	Создает карту в Google Wallet и возвращает ссылку для сохранения.
Validate a pass	Проверяет конфигурацию карты без ее создания.
Update a pass	Обновляет существующую карту. Google доставляет изменения на сохраненные устройства.
Get a save link	Возвращает ссылку “Добавить в Google Wallet” для сохранения существующей карты.
Get a pass	Возвращает одну сохраненную карту.
List passes	Возвращает постраничный список карт для приложения.
Set pass state	Активирует или делает недействительной карту.
Delete a pass	Делает карту недействительной в Google и удаляет ее запись в Pushwoosh.
Get configuration	Возвращает состояние конфигурации Google Wallet для приложения.
Templates	Выводит список шаблонов карт или получает один из них в качестве отправной точки.

API Customer Journey

Lifecycle	Запускает, приостанавливает, завершает, переводит в черновик или архивирует journey по его UUID.
Create and update	Создает новое определение journey или заменяет существующее.
Start by API	Добавляет пользователей в точку входа API запущенного journey.
Get Journey stats	Получает статистику для определенного journey по его ID.
Remove users from journeys	Удаляет одного или нескольких пользователей из всех или выбранных активных journey.

API запланированных запросов

getResults	Получает результат запланированного запроса.

SMS API

createSMSMessage Устарел	Создает новое SMS-сообщение. Вместо него используйте Notify с platforms: ["SMS"].

WhatsApp API

createWhatsAppMessage Устарел	Создает новое сообщение WhatsApp. Вместо него используйте Notify с platforms: ["WHATS_APP"].

LINE API

createLineMessage Устарел	Создает новое сообщение LINE. Вместо него используйте Notify с platforms: ["LINE"].

Kakao API

createKakaoMessage Устарел	Отправляет сообщение Kakao с использованием утвержденного шаблона. Вместо него используйте Notify с platforms: ["KAKAO"].

API геозон

getNearestZone	Получает параметры ближайшей геозоны и расстояние до нее. Также записывает местоположение устройства для гео-push-уведомлений.
addGeoZone	Добавляет геозону в определенное приложение.
updateGeoZone	Обновляет свойства геозоны, такие как имя, статус, контент и радиус действия.
deleteGeoZone	Удаляет геозоны из приложения.
addGeoZoneCluster	Добавляет кластер геозон в приложение.
deleteGeoZoneCluster	Удаляет кластер геозон из приложения.
listGeoZones	Получает список геозон для приложения.
listGeoZoneClusters	Получает список кластеров геозон для приложения.