Справочник по методам API
Pushwoosh предоставляет обширную библиотеку из более чем 100 методов API, сгруппированных по различным функциям, таким как отправка уведомлений, управление пользователями и отслеживание аналитики.
Messaging API v2
Anchor link toУнифицированный API, заменяющий все семейство методов /create*Message (push, email, SMS, Kakao). См. обзор и руководство по миграции.
Notify | Создает и отправляет одно сообщение через любой канал. Заменяет /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage. |
SMTP-шлюз
Anchor link toОтправляйте транзакционные email-сообщения по стандартному протоколу SMTP вместо прямого вызова API. Шлюз аутентифицируется с помощью кода вашего приложения и токена API, а затем пересылает каждое сообщение в Notify. См. справочник по SMTP-шлюзу.
Messages API
Anchor link tocreateMessage Устарел | Создает новое push-уведомление. Вместо него используйте Notify. |
deleteMessage | Удаляет запланированное сообщение. |
getMessageDetails | Получает детали сообщения. |
createTargetedMessage Устарел | Создает новое таргетированное push-уведомление. Вместо него используйте Notify с типом transactional. |
getPushHistory Устарел | Используйте /messages:list для получения истории сообщений с подробными данными. |
cancelMessage | Отменяет запланированное сообщение. |
Presets API
Anchor link tocreatePreset | Создает новый пресет. |
getPreset | Получает параметры указанного push-пресета. |
listPresets | Получает список пресетов, созданных для приложения. |
deletePreset | Удаляет пресет из вашего аккаунта. |
Device API
Anchor link toregisterDevice | Регистрирует устройство для приложения. |
unregisterDevice | Удаляет push-токен устройства. |
deleteDevice | Удаляет устройство и все связанные с ним данные в указанном приложении. |
setTags | Устанавливает значения тегов для устройства. |
getTags | Получает теги с их соответствующими значениями для конкретного устройства. |
setBadge | Отправляет текущее значение бейджа для устройства в Pushwoosh. |
applicationOpen | Регистрирует событие открытия приложения. |
pushStat | Регистрирует событие открытия push-уведомления. |
messageDeliveryEvent | Регистрирует событие доставки push-уведомления для устройства. |
Audience API
Anchor link tobulkSetTags | Устанавливает значения тегов для нескольких устройств. |
Статус bulkSetTags | Возвращает статус операции bulkSetTags. |
bulkRegisterDevice | Регистрирует несколько устройств в одном запросе, включая необязательные значения тегов для каждого устройства. |
Статус bulkRegisterDevice | Получает статус и результаты запроса на массовую регистрацию устройств по ID запроса. |
bulkUnregisterDevice | Отменяет регистрацию нескольких устройств в одном запросе. |
Статус bulkUnregisterDevice | Получает статус и результаты запроса на массовую отмену регистрации устройств по ID запроса. |
Tags API
Anchor link toaddTag | Создает тег в вашем аккаунте. |
deleteTag | Удаляет тег со всей связанной информацией. |
listTags | Получает список тегов в аккаунте. |
API Сегментации (Фильтры)
Anchor link tocreateFilter | Создает новый сегмент. |
listFilters | Возвращает список доступных сегментов с их условиями. |
deleteFilter | Удаляет существующий сегмент. |
exportSegment | Планирует запрос на экспорт подписчиков, соответствующих условиям сегмента. |
Результаты exportSegment | Получает ссылку на CSV-файл с результатами exportSegment. |
User-centric API
Anchor link toregisterUser | Связывает внешний User ID с указанным устройством. |
deleteUser | Удаляет пользователя и все устройства, связанные с указанным 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 | Получает список кампаний для приложения. |
API конфигурации приложения
Anchor link toconfigureApplication для iOS | Настраивает платформу iOS для приложения. |
configureApplication для Android | Настраивает платформу Android для приложения. |
configureApplication для Mac OS X | Настраивает платформу macOS для приложения. |
configureApplication для Windows | Настраивает платформу Windows для приложения. |
configureApplication для Amazon | Настраивает платформу Amazon для приложения. |
configureApplication для Chrome | Настраивает платформу Chrome для приложения. |
configureApplication для Safari | Настраивает платформу Safari для приложения. |
configureApplication для Firefox | Настраивает платформу Firefox для приложения. |
configureApplication для Email | Настраивает платформу Email для приложения. |
Email API
Anchor link tocreateEmailMessage Устарел | Создает email-сообщение. Вместо него используйте Notify с platforms: ["EMAIL"] и email_payload. |
registerEmail | Регистрирует email-адрес для приложения. |
deleteEmail | Удаляет email-адрес из вашей базы данных. |
setEmailTags | Устанавливает значения тегов для указанного email-адреса. |
registerEmailUser | Связывает внешний User ID с указанным email-адресом. |
API тестовых устройств
Anchor link tocreateTestDevice | Регистрирует тестовое устройство для приложения. |
listTestDevices | Получает все тестовые устройства, зарегистрированные для приложения. |
API папки входящих сообщений
Anchor link togetInboxMessages | Получает список сообщений из папки “Входящие” для указанного HWID. |
inboxStatus | Обновляет статус определенного сообщения в папке “Входящие”. |
API статистики
Anchor link toСтатистика сообщений
Anchor link tomessages:list | Получает список отправленных сообщений. |
totalsByIntervals | Предоставляет метрики и данные о конверсиях, сгруппированные по часам. |
getMessageLog | Получает подробную информацию об отправленных сообщениях. |
linksInteractions | Предоставляет статистику по кликам на ссылки в email-сообщениях. |
linksInteractionsDevices | Перечисляет пользователей, которые кликнули на ссылки в email-сообщениях. |
bouncedEmails | Предоставляет информацию о возвратах email-сообщений, жалобах и причинах возвратов. |
Статистика приложения и подписчиков
Anchor link togetApplicationSubscribersStats | Получает статистику подписчиков приложения, сгруппированную по типу устройства. |
getAppStats | Получает статистику приложения за определенный период времени. |
getSubscribersStatistics | Получает статистику подписчиков за определенный период времени. |
Статистика кампаний
Anchor link togetCampaignStats | Получает статистику кампании за определенный период времени. |
Статистика событий и тегов
Anchor link togetEventStatistics | Получает количество срабатываний события за определенный период. |
getTagStats | Получает статистику для определенного тега. |
iOS Live Activities API
Anchor link tostartLiveActivity | Создает новую iOS Live Activity. |
updateLiveActivity | Обновляет существующую iOS Live Activity. |
Apple Wallet PassKit API
Anchor link toApple Wallet PassKit API | Справочник по управлению картами Apple Wallet и соответствующей конфигурации в Pushwoosh. |
Customer Journey API
Anchor link toПолучить статистику Journey | Получает статистику для определенного Journey по его ID. |
Удалить пользователей из Journey | Удаляет одного или нескольких пользователей из всех или выбранных активных Journey. |
API запланированных запросов
Anchor link togetResults | Получает результат запланированного запроса. |
SMS API
Anchor link tocreateSMSMessage Устарел | Создает новое SMS-сообщение. Вместо него используйте Notify с platforms: ["SMS"]. |
WhatsApp API
Anchor link tocreateWhatsAppMessage Устарел | Создает новое сообщение WhatsApp. Вместо него используйте Notify с platforms: ["WHATS_APP"]. |
LINE API
Anchor link tocreateLineMessage Устарел | Создает новое сообщение LINE. Вместо него используйте Notify с platforms: ["LINE"]. |
Kakao API
Anchor link tocreateKakaoMessage Устарел | Отправляет сообщение Kakao с использованием утвержденного шаблона. Вместо него используйте Notify с platforms: ["KAKAO"]. |
Geozones API
Anchor link togetNearestZone | Получает параметры ближайшей геозоны и расстояние до нее. Также записывает местоположение устройства для гео-push-уведомлений. |
addGeoZone | Добавляет геозону в определенное приложение. |
updateGeoZone | Обновляет свойства геозоны, такие как имя, статус, контент и радиус действия. |
deleteGeoZone | Удаляет геозоны из приложения. |
addGeoZoneCluster | Добавляет кластер геозон в приложение. |
deleteGeoZoneCluster | Удаляет кластер геозон из приложения. |
listGeoZones | Получает список геозон для приложения. |
listGeoZoneClusters | Получает список кластеров геозон для приложения. |