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

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

Messages API

createMessage	Создает новое push-уведомление.
deleteMessage	Удаляет запланированное сообщение.
getMessageDetails	Получает детали сообщения.
createTargetedMessage	Создает новое целевое push-уведомление для расширенного таргетинга в нескольких приложениях.
getPushHistory	Получает историю сообщений с деталями push-уведомлений.
cancelMessage	Отменяет запланированное сообщение.

Presets API

createPreset	Создает новый preset.
getPreset	Получает параметры указанного push preset.
listPresets	Получает список presets, созданных для приложения.
deletePreset	Удаляет preset из вашего аккаунта.

Device API

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

Audience API

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

Tags API

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

Segmentation (Filters) API

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

User-centric API

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

Events API

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

Applications API

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

Campaigns API

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

App configuration 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-сообщение.
registerEmail	Регистрирует email-адрес для приложения.
deleteEmail	Удаляет email-адрес из вашей базы данных.
setEmailTags	Устанавливает значения тегов для указанного email-адреса.
registerEmailUser	Связывает внешний User ID с указанным email-адресом.

Test devices API

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

Message inbox API

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

Statistics API

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

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

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

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

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

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

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

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

iOS Live Activities API

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

Customer Journey statistics API

Get Journey stats	Получает статистику для определенного journey по его ID.

Scheduled requests API

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

SMS API

createSMSMessage	Создает новое SMS-сообщение.

WhatsApp API

createWhatsAppMessage	Создает новое сообщение WhatsApp.

Geozones API

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