Passer au contenu

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 Messages

Anchor link to
createMessageCrée une nouvelle notification push.
deleteMessageSupprime un message programmé.
getMessageDetailsRécupère les détails du message.
createTargetedMessageCrée une nouvelle notification push ciblée pour un ciblage avancé sur plusieurs applications.
getPushHistoryObtient l’historique des messages avec les détails des pushs.
cancelMessageAnnule un message programmé.

API Préréglages

Anchor link to
createPresetCrée un nouveau préréglage.
getPresetRécupère les paramètres du préréglage de push spécifié.
listPresetsRécupère une liste des préréglages créés pour l’application.
deletePresetSupprime un préréglage de votre compte.

API Appareil

Anchor link to
registerDeviceEnregistre un appareil pour l’application.
unregisterDeviceSupprime le jeton de push de l’appareil.
setTagsDéfinit les valeurs des tags pour l’appareil.
getTagsRécupère les tags avec leurs valeurs correspondantes pour un appareil spécifique.
setBadgeEnvoie la valeur actuelle du badge pour un appareil à Pushwoosh.
applicationOpenEnregistre un événement d’ouverture d’application.
pushStatEnregistre un événement d’ouverture de push.
messageDeliveryEventEnregistre un événement de livraison de push pour l’appareil.

API Audience

Anchor link to
bulkSetTagsDéfinit les valeurs de tags pour plusieurs appareils.
bulkSetTags StatusRetourne le statut de l’opération bulkSetTags.
bulkRegisterDeviceEnregistre plusieurs appareils en une seule requête, y compris les valeurs de tags optionnelles pour chaque appareil.
bulkRegisterDevice StatusRé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.
bulkUnregisterDeviceDésenregistre plusieurs appareils en une seule requête.
bulkUnregisterDevice StatusRé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.
addTagCrée un tag dans votre compte.
deleteTagSupprime un tag avec toutes les informations associées.
listTagsRécupère une liste de tags sur le compte.

API Segmentation (Filtres)

Anchor link to
createFilterCrée un nouveau segment.
listFiltersRetourne une liste des segments disponibles avec leurs conditions.
deleteFilterSupprime un segment existant.
exportSegmentProgramme une requête pour exporter les abonnés correspondant aux conditions du segment.
exportSegment ResultsRécupère le lien CSV pour les résultats de exportSegment.

API centrée sur l’utilisateur

Anchor link to
registerUserAssocie un ID utilisateur externe à un appareil spécifié.
postEventAppelle l’événement au sein de l’application.

API Événements

Anchor link to
createEventCrée un événement pour l’application.

API Applications

Anchor link to
createApplicationCrée une nouvelle application sur le compte.
updateApplicationMet à jour les paramètres de l’application.
deleteApplicationSupprime l’application du compte.
getApplicationObtient des détails sur l’application.
getApplicationsRécupère une liste d’applications sur le compte.
getApplicationFileRécupère les fichiers de configuration liés à l’application.
setApplicationPlatformStatusModifie le statut de la plateforme de l’application.

API Campagnes

Anchor link to
createCampaignCrée une nouvelle campagne de push.
deleteCampaignSupprime une campagne particulière.
getCampaignsRécupère une liste de campagnes pour l’application.

API Configuration d’application

Anchor link to
configureApplication for iOSConfigure la plateforme iOS pour l’application.
configureApplication for AndroidConfigure la plateforme Android pour l’application.
configureApplication for Mac OS XConfigure la plateforme macOS pour l’application.
configureApplication for WindowsConfigure la plateforme Windows pour l’application.
configureApplication for AmazonConfigure la plateforme Amazon pour l’application.
configureApplication for ChromeConfigure la plateforme Chrome pour l’application.
configureApplication for SafariConfigure la plateforme Safari pour l’application.
configureApplication for FirefoxConfigure la plateforme Firefox pour l’application.
configureApplication for EmailConfigure la plateforme E-mail pour l’application.

API E-mail

Anchor link to
createEmailMessageCrée un message e-mail.
registerEmailEnregistre une adresse e-mail pour l’application.
deleteEmailSupprime une adresse e-mail de votre base de données.
setEmailTagsDéfinit les valeurs de tags pour l’adresse e-mail spécifiée.
registerEmailUserAssocie un ID utilisateur externe à une adresse e-mail spécifiée.

API Appareils de test

Anchor link to
createTestDeviceEnregistre un appareil de test pour l’application.
listTestDevicesRécupère tous les appareils de test enregistrés pour l’application.

API Boîte de réception des messages

Anchor link to
getInboxMessagesRécupère la liste des messages de la boîte de réception pour un HWID spécifié.
inboxStatusMet à jour le statut d’un message spécifique de la boîte de réception.

API Statistiques

Anchor link to

Statistiques des messages

Anchor link to
messages:listRécupère une liste des messages envoyés.
totalsByIntervalsFournit des métriques et des données de conversion agrégées par heure.
getMessageLogRécupère des informations détaillées sur les messages envoyés.
linksInteractionsFournit des statistiques sur les clics sur les liens des e-mails.
linksInteractionsDevicesListe les utilisateurs qui ont cliqué sur les liens dans les e-mails.
bouncedEmailsFournit des informations sur les rebonds d’e-mails, les plaintes et les raisons des rebonds.

Statistiques de l’application et des abonnés

Anchor link to
getApplicationSubscribersStatsRécupère les statistiques d’abonnés de l’application, regroupées par type d’appareil.
getAppStatsRécupère les statistiques de l’application pour une période donnée.
getSubscribersStatisticsRécupère les statistiques des abonnés pour une période donnée.

Statistiques des campagnes

Anchor link to
getCampaignStatsRécupère les statistiques de campagne pour une période donnée.

Statistiques des événements et des tags

Anchor link to
getEventStatisticsRécupère le nombre de fois qu’un événement a été déclenché pendant une période spécifique.
getTagStatsRécupère les statistiques pour un tag spécifique.

API Live Activities iOS

Anchor link to
startLiveActivityCrée une nouvelle Live Activity iOS.
updateLiveActivityMet à jour une Live Activity iOS existante.

API Customer Journey

Anchor link to
Get Journey statsObtient les statistiques pour un parcours spécifique grâce à son ID.
Remove users from journeysSupprime un ou plusieurs utilisateurs de tous les parcours actifs ou de parcours sélectionnés.

API Requêtes programmées

Anchor link to
getResultsRécupère le résultat d’une requête programmée.
createSMSMessageCrée un nouveau message SMS.

API WhatsApp

Anchor link to
createWhatsAppMessageCrée un nouveau message WhatsApp.
createLineMessageCrée un nouveau message LINE.
createKakaoMessageEnvoie un message Kakao en utilisant un modèle approuvé.

API Géozones

Anchor link to
getNearestZoneRé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.
addGeoZoneAjoute une Géozone à une application spécifique.
updateGeoZoneMet à jour les propriétés de la Géozone telles que le nom, le statut, le contenu et la portée.
deleteGeoZoneSupprime des Géozones de l’application.
addGeoZoneClusterAjoute un Cluster de Géozones à l’application.
deleteGeoZoneClusterSupprime un Cluster de Géozones de l’application.
listGeoZonesRécupère une liste de Géozones pour l’application.
listGeoZoneClustersRécupère une liste de clusters de Géozones pour l’application.