Справочник по методам API
Pushwoosh предоставляет обширную библиотеку из более чем 100 методов API, разделенных по категориям для различных функций, таких как отправка уведомлений, управление пользователями и отслеживание аналитики.
Messages API
Anchor link tocreateMessage | Создает новое push-уведомление. |
deleteMessage | Удаляет запланированное сообщение. |
getMessageDetails | Получает детали сообщения. |
createTargetedMessage | Создает новое таргетированное push-уведомление для расширенного таргетинга в нескольких приложениях. |
getPushHistory | Получает историю сообщений с деталями push-уведомлений. |
cancelMessage | Отменяет запланированное сообщение. |
Presets API
Anchor link tocreatePreset | Создает новый пресет. |
getPreset | Получает параметры указанного пресета push-уведомлений. |
listPresets | Получает список пресетов, созданных для приложения. |
deletePreset | Удаляет пресет из вашего аккаунта. |
Device API
Anchor link toregisterDevice | Регистрирует устройство для приложения. |
unregisterDevice | Удаляет push-токен устройства. |
setTags | Устанавливает значения тегов для устройства. |
getTags | Получает теги с их соответствующими значениями для определенного устройства. |
setBadge | Отправляет текущее значение бейджа для устройства в Pushwoosh. |
applicationOpen | Регистрирует событие открытия приложения. |
pushStat | Регистрирует событие открытия push-уведомления. |
messageDeliveryEvent | Регистрирует событие доставки push-уведомления для устройства. |
Audience API
Anchor link tobulkSetTags | Устанавливает значения тегов для нескольких устройств. |
bulkSetTags Status | Возвращает статус операции bulkSetTags. |
bulkRegisterDevice | Регистрирует несколько устройств в одном запросе, включая необязательные значения тегов для каждого устройства. |
bulkRegisterDevice Status | Получает статус и результаты запроса на массовую регистрацию устройств по ID запроса. |
bulkUnregisterDevice | Отменяет регистрацию нескольких устройств в одном запросе. |
bulkUnregisterDevice Status | Получает статус и результаты запроса на массовую отмену регистрации устройств по ID запроса. |
Tags API
Anchor link toaddTag | Создает тег в вашем аккаунте. |
deleteTag | Удаляет тег со всей связанной информацией. |
listTags | Получает список тегов в аккаунте. |
Segmentation (Filters) API
Anchor link tocreateFilter | Создает новый сегмент. |
listFilters | Возвращает список доступных сегментов с их условиями. |
deleteFilter | Удаляет существующий сегмент. |
exportSegment | Планирует запрос на экспорт подписчиков, соответствующих условиям сегмента. |
exportSegment Results | Получает ссылку на CSV-файл с результатами exportSegment. |
User-centric API
Anchor link toregisterUser | Связывает внешний User ID с указанным устройством. |
postEvent | Вызывает событие в приложении. |
Events API
Anchor link tocreateEvent | Создает событие для приложения. |
Applications API
Anchor link tocreateApplication | Создает новое приложение в аккаунте. |
updateApplication | Обновляет настройки приложения. |
deleteApplication | Удаляет приложение из аккаунта. |
getApplication | Получает детали о приложении. |
getApplications | Получает список приложений в аккаунте. |
getApplicationFile | Получает файлы конфигурации, связанные с приложением. |
setApplicationPlatformStatus | Изменяет статус платформы для приложения. |
Campaigns API
Anchor link tocreateCampaign | Создает новую push-кампанию. |
deleteCampaign | Удаляет определенную кампанию. |
getCampaigns | Получает список кампаний для приложения. |
App configuration API
Anchor link toconfigureApplication 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
Anchor link tocreateEmailMessage | Создает email-сообщение. |
registerEmail | Регистрирует email-адрес для приложения. |
deleteEmail | Удаляет email-адрес из вашей базы данных. |
setEmailTags | Устанавливает значения тегов для указанного email-адреса. |
registerEmailUser | Связывает внешний User ID с указанным email-адресом. |
Test devices API
Anchor link tocreateTestDevice | Регистрирует тестовое устройство для приложения. |
listTestDevices | Получает все тестовые устройства, зарегистрированные для приложения. |
Message inbox API
Anchor link togetInboxMessages | Получает список сообщений Message Inbox для указанного HWID. |
inboxStatus | Обновляет статус определенного сообщения в Message Inbox. |
Statistics API
Anchor link toMessage statistics
Anchor link tomessages:list | Получает список отправленных сообщений. |
totalsByIntervals | Предоставляет метрики и данные о конверсиях, сгруппированные по часам. |
getMessageLog | Получает подробную информацию об отправленных сообщениях. |
linksInteractions | Предоставляет статистику по кликам на ссылки в email-сообщениях. |
linksInteractionsDevices | Выводит список пользователей, которые кликнули на ссылки в email-сообщениях. |
bouncedEmails | Предоставляет информацию о возвратах (bounces), жалобах и причинах возвратов email-сообщений. |
Application and subscriber statistics
Anchor link togetApplicationSubscribersStats | Получает статистику подписчиков приложения, сгруппированную по типу устройства. |
getAppStats | Получает статистику приложения за определенный период времени. |
getSubscribersStatistics | Получает статистику подписчиков за определенный период времени. |
Campaign statistics
Anchor link togetCampaignStats | Получает статистику кампании за определенный период времени. |
Events and tags statistics
Anchor link togetEventStatistics | Получает количество срабатываний события за определенный период. |
getTagStats | Получает статистику по определенному тегу. |
iOS Live Activities API
Anchor link tostartLiveActivity | Создает новое iOS Live Activity. |
updateLiveActivity | Обновляет существующее iOS Live Activity. |
Customer Journey statistics API
Anchor link toGet Journey stats | Получает статистику для определенного Customer Journey по его ID. |
Scheduled requests API
Anchor link togetResults | Получает результат запланированного запроса. |
SMS API
Anchor link tocreateSMSMessage | Создает новое SMS-сообщение. |
WhatsApp API
Anchor link tocreateWhatsAppMessage | Создает новое сообщение WhatsApp. |
LINE API
Anchor link tocreateLineMessage | Создает новое сообщение LINE. |
Geozones API
Anchor link togetNearestZone | Получает параметры ближайшей геозоны и расстояние до нее. Также записывает местоположение устройства для гео-push-уведомлений. |
addGeoZone | Добавляет геозону в определенное приложение. |
updateGeoZone | Обновляет свойства геозоны, такие как название, статус, контент и радиус действия. |
deleteGeoZone | Удаляет геозоны из приложения. |
addGeoZoneCluster | Добавляет кластер геозон в приложение. |
deleteGeoZoneCluster | Удаляет кластер геозон из приложения. |
listGeoZones | Получает список геозон для приложения. |
listGeoZoneClusters | Получает список кластеров геозон для приложения. |