Index de référence des méthodes API

Pushwoosh fournit une vaste bibliothèque de plus de 100 méthodes API, classées pour diverses fonctionnalités telles que l’envoi de notifications, la gestion des utilisateurs et le suivi des analyses.

API de messagerie v2

API unifiée qui remplace toute la famille /create*Message (push, e-mail, SMS, Kakao). Consultez la vue d’ensemble et le guide de migration.

Notify	Crée et envoie un message unique via n’importe quel canal. Remplace /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage.
Cancel	Annule un message créé précédemment avant sa livraison. À utiliser avec le message_code de Notify.
Update	Remplace un message encore planifié par une nouvelle définition (remplacement complet). À utiliser avec le message_code de Notify.

Passerelle SMTP

Soumettez des e-mails transactionnels via SMTP standard au lieu d’appeler directement l’API. La passerelle s’authentifie avec votre code d’application et votre jeton API, puis transmet chaque message à Notify. Consultez la référence de la passerelle SMTP.

API des messages

createMessage Obsolète	Crée une nouvelle notification push. Utilisez plutôt Notify.
deleteMessage	Supprime un message (envoyé ou planifié) et le retire de l’historique des messages.
getMessageDetails	Récupère les détails du message.
createTargetedMessage Obsolète	Crée une nouvelle notification push ciblée. Utilisez plutôt Notify avec le type transactional.
getPushHistory Obsolète	Utilisez /messages:list pour récupérer l’historique des messages avec des données détaillées.
cancelMessage	Annule un message planifié, en le conservant dans l’historique des messages.

API des préréglages

createPreset	Crée un nouveau préréglage.
getPreset	Récupère les paramètres du préréglage de push spécifié.
listPresets	Récupère une liste des préréglages créés pour l’application.
deletePreset	Supprime un préréglage de votre compte.

API des appareils

registerDevice	Enregistre un appareil pour l’application.
unregisterDevice	Supprime le jeton de push de l’appareil.
deleteDevice	Supprime un appareil et toutes ses données associées dans l’application spécifiée.
setTags	Définit les valeurs des tags pour l’appareil.
getTags	Récupère les tags avec leurs valeurs correspondantes pour un appareil spécifique.
setBadge	Envoie la valeur actuelle du badge pour un appareil à Pushwoosh.
applicationOpen	Enregistre un événement d’ouverture d’application.
pushStat	Enregistre un événement d’ouverture de push.
messageDeliveryEvent	Enregistre un événement de livraison de push pour l’appareil.

API de l’audience

bulkSetTags	Définit les valeurs des tags pour plusieurs appareils.
bulkSetTags Status	Retourne le statut de l’opération bulkSetTags.
bulkRegisterDevice	Enregistre plusieurs appareils en une seule requête, y compris les valeurs de tags optionnelles pour chaque appareil.
bulkRegisterDevice Status	Récupère le statut et les résultats d’une requête d’enregistrement d’appareils en masse à l’aide d’un ID de requête.
bulkUnregisterDevice	Désenregistre plusieurs appareils en une seule requête.
bulkUnregisterDevice Status	Récupère le statut et les résultats d’une requête de désenregistrement d’appareils en masse à l’aide d’un ID de requête.

API des tags

addTag	Crée un tag dans votre compte.
deleteTag	Supprime un tag avec toutes les informations associées.
listTags	Récupère une liste des tags sur le compte.

API de segmentation (Filtres)

createFilter	Crée un nouveau segment.
listFilters	Retourne une liste des segments disponibles avec leurs conditions.
deleteFilter	Supprime un segment existant.
exportSegment	Planifie une requête pour exporter les abonnés correspondant aux conditions du segment.
exportSegment Results	Récupère le lien CSV pour les résultats de exportSegment.

API centrée sur l’utilisateur

registerUser	Associe un ID utilisateur externe à un appareil spécifié.
deleteUser	Supprime un utilisateur et tous les appareils associés à l’ID utilisateur spécifié.
postEvent	Appelle l’événement dans l’application.

API des événements

createEvent	Crée un événement pour l’application.

API des applications

createApplication	Crée une nouvelle application sur le compte.
updateApplication	Met à jour les paramètres de l’application.
deleteApplication	Supprime l’application du compte.
getApplication	Obtient des détails sur l’application.
getApplications	Récupère une liste des applications sur le compte.
getApplicationFile	Récupère les fichiers de configuration liés à l’application.
setApplicationPlatformStatus	Modifie le statut de la plateforme de l’application.

API des campagnes

createCampaign	Crée une nouvelle campagne de push.
deleteCampaign	Supprime une campagne particulière.
getCampaigns	Récupère une liste des campagnes pour l’application.

API de configuration d’application

configureApplication for iOS	Configure la plateforme iOS pour l’application.
configureApplication for Android	Configure la plateforme Android pour l’application.
configureApplication for Mac OS X	Configure la plateforme macOS pour l’application.
configureApplication for Windows	Configure la plateforme Windows pour l’application.
configureApplication for Amazon	Configure la plateforme Amazon pour l’application.
configureApplication for Chrome	Configure la plateforme Chrome pour l’application.
configureApplication for Safari	Configure la plateforme Safari pour l’application.
configureApplication for Firefox	Configure la plateforme Firefox pour l’application.
configureApplication for Email	Configure la plateforme E-mail pour l’application.

API E-mail

createEmailMessage Obsolète	Crée un message e-mail. Utilisez plutôt Notify avec platforms: ["EMAIL"] et une charge utile e-mail.
registerEmail	Enregistre une adresse e-mail pour l’application.
deleteEmail	Supprime une adresse e-mail de votre base de données.
setEmailTags	Définit les valeurs des tags pour l’adresse e-mail spécifiée.
registerEmailUser	Associe un ID utilisateur externe à une adresse e-mail spécifiée.

API des appareils de test

createTestDevice	Enregistre un appareil de test pour l’application.
listTestDevices	Récupère tous les appareils de test enregistrés pour l’application.

API de la boîte de réception des messages

getInboxMessages	Récupère la liste des messages de la boîte de réception pour un HWID spécifié.
inboxStatus	Met à jour le statut d’un message spécifique de la boîte de réception.

API des statistiques

Statistiques des messages

messages:list	Récupère une liste des messages envoyés.
totalsByIntervals	Fournit des métriques et des données de conversion agrégées par heure.
getDeliveryFunnel	Retourne l’entonnoir de livraison pour un message unique, avec une ventilation des endroits où l’audience est perdue à chaque étape.
getMessageLog	Récupère des informations détaillées sur les messages envoyés.
linksInteractions	Fournit des statistiques sur les clics sur les liens des e-mails.
linksInteractionsDevices	Liste les utilisateurs qui ont cliqué sur les liens dans les e-mails.
bouncedEmails	Fournit des informations sur les rebonds d’e-mails, les plaintes et les raisons des rebonds.

Statistiques de l’application et des abonnés

getApplicationSubscribersStats	Récupère les statistiques des abonnés de l’application, groupées par type d’appareil.
getAppStats	Récupère les statistiques de l’application pour une période de temps spécifique.
getSubscribersStatistics	Récupère les statistiques des abonnés pour une période de temps spécifique.

Statistiques des campagnes

getCampaignStats	Récupère les statistiques de campagne pour une période de temps spécifique.

Statistiques des événements et des tags

getEventStatistics	Récupère le nombre de fois qu’un événement a été déclenché pendant une période spécifique.
getTagStats	Récupère les statistiques pour un tag spécifique.

Statistiques In-App

inapps:totals	Récupère les totaux d’impressions, d’interactions et de plafonnement de fréquence pour une ou plusieurs campagnes in-app sur une période.
inapps:timeline	Récupère les totaux de la période et une série chronologique de métriques in-app pour une seule campagne.

API des Activités en direct d’iOS

startLiveActivity	Crée une nouvelle Activité en direct d’iOS.
updateLiveActivity	Met à jour une Activité en direct d’iOS existante.

API PassKit d’Apple Wallet

API PassKit d'Apple Wallet	Référence pour la gestion des passes Apple Wallet et de la configuration associée dans Pushwoosh.

API Google Wallet

Créer un pass	Crée le pass dans Google Wallet et retourne un lien de sauvegarde.
Valider un pass	Vérifie la configuration d’un pass sans le créer.
Mettre à jour un pass	Met à jour un pass existant. Google transmet la modification aux appareils enregistrés.
Obtenir un lien de sauvegarde	Retourne un lien de sauvegarde « Ajouter à Google Wallet » pour un pass existant.
Obtenir un pass	Retourne un seul pass stocké.
Lister les passes	Retourne une liste paginée de passes pour une application.
Définir l'état du pass	Active ou invalide un pass.
Supprimer un pass	Invalide le pass dans Google et supprime son enregistrement Pushwoosh.
Obtenir la configuration	Retourne l’état de configuration de Google Wallet pour une application.
Modèles	Liste les modèles de passes ou en récupère un comme point de départ.

API Customer Journey

Cycle de vie	Démarre, met en pause, termine, met en brouillon ou archive un parcours par son UUID.
Créer et mettre à jour	Crée une nouvelle définition de parcours ou remplace une existante.
Démarrer par API	Injecte des utilisateurs dans le point d’entrée API d’un parcours en cours d’exécution.
Obtenir les statistiques du parcours	Obtient les statistiques pour un parcours spécifique par son ID.
Supprimer des utilisateurs des parcours	Supprime un ou plusieurs utilisateurs de tous les parcours actifs ou de parcours sélectionnés.

API des requêtes planifiées

getResults	Récupère le résultat d’une requête planifiée.

API SMS

createSMSMessage Obsolète	Crée un nouveau message SMS. Utilisez plutôt Notify avec platforms: ["SMS"].

API WhatsApp

createWhatsAppMessage Obsolète	Crée un nouveau message WhatsApp. Utilisez plutôt Notify avec platforms: ["WHATS_APP"].

API LINE

createLineMessage Obsolète	Crée un nouveau message LINE. Utilisez plutôt Notify avec platforms: ["LINE"].

API Kakao

createKakaoMessage Obsolète	Envoie un message Kakao en utilisant un modèle approuvé. Utilisez plutôt Notify avec platforms: ["KAKAO"].

API des Géozones

getNearestZone	Récupère les paramètres de la géozone la plus proche et la distance qui l’en sépare. Enregistre également l’emplacement de l’appareil pour les notifications push géolocalisées.
addGeoZone	Ajoute une Géozone à une application spécifique.
updateGeoZone	Met à jour les propriétés de la Géozone telles que le nom, le statut, le contenu et la portée.
deleteGeoZone	Supprime les Géozones de l’application.
addGeoZoneCluster	Ajoute un Cluster de Géozones à l’application.
deleteGeoZoneCluster	Supprime un Cluster de Géozones de l’application.
listGeoZones	Récupère une liste de Géozones pour l’application.
listGeoZoneClusters	Récupère une liste de clusters de Géozones pour l’application.