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.

Messaging API v2

API unifiée qui remplace toute la famille /create*Message (push, e-mail, SMS, Kakao). Consultez la présentation 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.

Passerelle SMTP

Envoyez 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 Messages

createMessage Obsolète	Crée une nouvelle notification push. Utilisez Notify à la place.
deleteMessage	Supprime un message programmé.
getMessageDetails	Récupère les détails du message.
createTargetedMessage Obsolète	Crée une nouvelle notification push ciblée. Utilisez Notify avec le type transactional à la place.
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 programmé.

API Préréglages

createPreset	Crée un nouveau préréglage.
getPreset	Récupère les paramètres du préréglage 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 Appareil

registerDevice	Enregistre un appareil pour l’application.
unregisterDevice	Supprime le jeton 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 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 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 de tags sur le compte.

API 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 Événements

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

API 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 d’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 Campagnes

createCampaign	Crée une nouvelle campagne push.
deleteCampaign	Supprime une campagne particulière.
getCampaigns	Récupère une liste de 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 Notify avec platforms: ["EMAIL"] et un email_payload à la place.
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 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 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 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.
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 d’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 de campagne

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.

API iOS Live Activities

startLiveActivity	Crée une nouvelle Live Activity iOS.
updateLiveActivity	Met à jour une Live Activity iOS existante.

API Apple Wallet PassKit

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

API Google Wallet

Create a pass	Crée le pass dans Google Wallet et retourne un lien de sauvegarde.
Validate a pass	Vérifie la configuration d’un pass sans le créer.
Update a pass	Met à jour un pass existant. Google transmet la modification aux appareils enregistrés.
Get a save link	Retourne un lien de sauvegarde “Ajouter à Google Wallet” pour un pass existant.
Get a pass	Retourne un seul pass stocké.
List passes	Retourne une liste paginée de passes pour une application.
Set pass state	Active ou invalide un pass.
Delete a pass	Invalide le pass dans Google et supprime son enregistrement Pushwoosh.
Get configuration	Retourne l’état de la configuration de Google Wallet pour une application.
Templates	Liste les modèles de passes ou en récupère un comme point de départ.

API Customer Journey

Lifecycle	Démarre, met en pause, termine, met en brouillon ou archive un parcours par son UUID.
Create and update	Crée une nouvelle définition de parcours ou remplace une définition existante.
Start by API	Injecte des utilisateurs dans le point d’entrée API d’un parcours en cours d’exécution.
Get Journey stats	Obtient des statistiques pour un parcours spécifique par son ID.
Remove users from journeys	Supprime un ou plusieurs utilisateurs de tous les parcours actifs ou de parcours sélectionnés.

API 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 Notify avec platforms: ["SMS"] à la place.

API WhatsApp

createWhatsAppMessage Obsolète	Crée un nouveau message WhatsApp. Utilisez Notify avec platforms: ["WHATS_APP"] à la place.

API LINE

createLineMessage Obsolète	Crée un nouveau message LINE. Utilisez Notify avec platforms: ["LINE"] à la place.

API Kakao

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

API 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.