Paramètres de /createMessage

Vous trouverez ici la description des paramètres de l’API /createMessage. Les paramètres requis garantissent la publication réussie d’une requête API /createMessage et l’envoi d’une notification push de diffusion à l’heure spécifiée. Les paramètres optionnels vous permettent de personnaliser en profondeur les propriétés des notifications push.

Les paramètres requis sont obligatoires pour les requêtes /createMessage. Sinon, la requête ne sera pas soumise.

Code unique d’une application créée dans votre compte Pushwoosh. Le code de l’application se trouve dans le coin supérieur gauche du Control Panel ou dans la réponse à une requête /createApplication. Le code de l’application est un ensemble de 10 caractères (lettres et chiffres) séparés par des tirets.

Lors de la création d’une application via l’API, vous obtiendrez un code d’application en réponse à votre requête /createApplication.

Pour obtenir le code d’une application précédemment créée via l’API, appelez /getApplications. En réponse à la requête /getApplications, vous recevrez la liste de toutes les applications créées dans votre compte Pushwoosh avec leurs noms et leurs codes.

Jeton d’accès API du Control Panel de Pushwoosh. Allez dans Settings → API Access et copiez un jeton que vous souhaitez utiliser ou générez-en un nouveau.

Lors de la génération d’un jeton d’accès, spécifiez ses autorisations. Cochez les cases correspondant aux types d’activités pour lesquelles vous allez utiliser le jeton d’API. Vous pouvez créer des jetons d’API spécifiques à une application en cochant les cases des Applications.

Une chaîne de caractères ou un objet pour définir le contenu d’un message. Le paramètre “content” soumis avec une valeur de type chaîne de caractères enverra le même message à tous les destinataires.

"content": "Hello world!",

Les objets JSON sont utilisés pour spécifier le contenu en utilisant le Dynamic Content, par exemple, pour les messages multilingues.

"content": {
  "en": "Hello!",
  "es": "¡Hola!",
  "de": "Hallo!"
},

Un tableau JSON des propriétés du push. Doit inclure au moins les paramètres requis “content” et “send_date”.

Paramètres optionnels à utiliser dans le tableau “notifications” :

• campaign
• capping_days
• capping_count
• conditions
• data
• devices
• dynamic_content
• filter
• ignore_user_timezone
• inbox_date
• inbox_image
• link
• minimize_link
• platforms
• preset
• rich_media
• send_rate
• timezone
• template_bindings
• transactionId
• users

Date et heure d’envoi du message. Peut être n’importe quelle date et heure au format AAAA-MM-JJ HH:mm ou ‘now’. S’il est défini sur ‘now’, le message sera envoyé immédiatement après la soumission de la requête.

Code d’une Campaign. Pour obtenir un code de Campaign, allez dans Channels → Statistics et sélectionnez la Campaign que vous allez utiliser. Vous trouverez le code de la campagne à la fin de l’URL de la page, après campaigns-statistic. Il s’agit d’un ensemble de 10 caractères (lettres et chiffres) séparés par des tirets.

Pour obtenir une liste des Campaigns avec leurs codes, appelez /getCampaigns. En réponse à la requête /getCampaigns, vous recevrez la liste de toutes les Campaigns créées pour une application particulière dans votre compte Pushwoosh, avec leurs codes, noms et descriptions.

Période à appliquer pour la limitation de la fréquence, en jours (max 30 jours).

Le nombre maximum de pushes pouvant être envoyés d’une application spécifique à un appareil particulier au cours d’une période “capping_days”. Si le message créé dépasse la limite “capping_count” pour un appareil, il ne sera pas envoyé à cet appareil.

Les conditions sont des tableaux comme [tagName, operator, operand] utilisés pour envoyer des messages ciblés basés sur les Tags et leurs valeurs, où :

• tagName — le nom d’un Tag à appliquer,
• operator — un opérateur de comparaison de valeur (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”),
• operand — les valeurs de Tag de l’un des types suivants : chaîne de caractères | entier | tableau | date | booléen | liste

• EQ : la valeur du Tag est égale à l’opérande ;
• IN : la valeur du Tag s’intersecte avec l’opérande (l’opérande doit toujours être un tableau) ;
• NOTEQ : la valeur du Tag n’est pas égale à l’opérande ;
• NOTIN : la valeur du Tag ne s’intersecte pas avec l’opérande (l’opérande doit toujours être un tableau) ;
• GTE : la valeur du Tag est supérieure ou égale à l’opérande ;
• LTE : la valeur du Tag est inférieure ou égale à l’opérande ;
• BETWEEN : la valeur du Tag est supérieure ou égale à la valeur minimale de l’opérande mais inférieure ou égale à la valeur maximale de l’opérande (l’opérande doit toujours être un tableau) ;
• NOTSET : le Tag n’est pas défini. L’opérande n’est pas pris en compte ;
• ANY : le Tag a n’importe quelle valeur. L’opérande n’est pas pris en compte.

Opérateurs valides : EQ, IN, NOTEQ, NOTIN, NOTSET, ANY
Opérandes valides :

• EQ, NOTEQ : l’opérande doit être une chaîne de caractères ;
• IN, NOTIN : l’opérande doit être un tableau de chaînes de caractères comme ["valeur 1", "valeur 2", "valeur N"] ;
• NOTSET : le Tag n’est pas défini. L’opérande n’est pas pris en compte ;
• ANY : le Tag a n’importe quelle valeur. L’opérande n’est pas pris en compte.

Opérateurs valides : EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY
Opérandes valides :

• EQ, NOTEQ, GTE, LTE : l’opérande doit être un entier ;
• IN, NOTIN : l’opérande doit être un tableau d’entiers comme [valeur 1, valeur 2, valeur N] ;
• BETWEEN : l’opérande doit être un tableau d’entiers comme [valeur_min, valeur_max] ;
• NOTSET : le Tag n’est pas défini. L’opérande n’est pas pris en compte ;
• ANY : le Tag a n’importe quelle valeur. L’opérande n’est pas pris en compte.

Opérateurs valides : EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY
Opérandes valides :

• "AAAA-MM-JJ 00:00" (chaîne de caractères)
• timestamp unix 1234567890 (entier)
• "Il y a N jours" (chaîne de caractères) pour les opérateurs EQ, BETWEEN, GTE, LTE

Opérateurs valides : EQ, NOTSET, ANY
Opérandes valides : 0, 1, true, false

Opérateurs valides : IN, NOTIN, NOTSET, ANY
Opérandes valides : l’opérande doit être un tableau de chaînes de caractères comme ["valeur 1", "valeur 2", "valeur N"].

Opérateur logique pour les tableaux de conditions. Valeurs possibles : AND | OR. AND est la valeur par défaut.

Si l’opérateur appliqué est AND (lorsqu’aucun opérateur n’est spécifié, ou si le paramètre ‘conditions_operator’ a la valeur ‘AND’), les appareils respectant simultanément toutes les conditions recevront la notification push.

Si l’opérateur est OR, les appareils qui respectent l’une des conditions spécifiées recevront le message.

Chaîne de caractères JSON ou objet JSON utilisé pour transmettre des données personnalisées dans la charge utile (payload) du push ; est passé en tant que paramètre “u” dans la charge utile (converti en chaîne de caractères JSON).

Un tableau de jetons Push ou de HWID pour envoyer des notifications push ciblées. S’il est défini, le message ne sera envoyé qu’aux appareils de la liste.

Variables (placeholders) pour le Dynamic Content à utiliser à la place des valeurs des Tags de l’appareil. L’exemple ci-dessous enverra le message “Hello, John!” à chaque utilisateur que vous ciblez. Si non défini, les valeurs du Dynamic Content sont extraites des Tags de l’appareil.

"content": "Hello, {firstname|CapitalizeFirst}!",
"dynamic_content_placeholders": {
  "firstname": "John",
  "lastname": "Doe"
},

Nom d’un Segment exactement tel qu’il a été créé dans le Control Panel de Pushwoosh ou via une requête API /createFilter. Allez dans la section Audience → Segments (Filters) et consultez la liste des Segments créés.

Pour obtenir la liste des Segments via l’API, appelez la méthode d’API /listFilters. En réponse à la requête /listFilters, vous recevrez la liste de tous les Segments créés dans votre compte Pushwoosh, avec les noms, les conditions et les dates d’expiration des Segments.

S’il est défini sur ‘true’, envoie le message à la date et à l’heure spécifiées dans le paramètre “send_date” selon le fuseau horaire UTC-0.

S’il est défini sur ‘false’, les utilisateurs recevront le message à l’heure locale spécifiée, en fonction des paramètres de leur appareil.

Date jusqu’à laquelle le message doit être conservé dans l’Inbox des utilisateurs. Si elle n’est pas spécifiée, le message sera supprimé de l’Inbox le lendemain de la date d’envoi.

L’URL de l’image personnalisée à afficher à côté du message dans l’Inbox.

La durée de vie d’un message de l’inbox en jours, jusqu’à 30 jours. Passé ce délai, le message sera supprimé de l’inbox. Peut être utilisé à la place du paramètre inbox_date.

L’URL à ouvrir une fois que l’utilisateur ouvre une notification push.

Raccourcisseur pour minimiser l’URL soumise dans le paramètre “link”. Veuillez noter que la taille de la charge utile (payload) des notifications push est limitée, pensez donc à créer des URL courtes pour ne pas dépasser la limite. Valeurs disponibles : 0 — ne pas minimiser, 2 — bitly. Par défaut = 2. Le raccourcisseur d’URL de Google est désactivé depuis le 30 mars 2019.

Un tableau de codes de plateformes pour n’envoyer le message qu’à des plateformes spécifiques. Liste des plateformes disponibles : Les codes de plateforme disponibles incluent : 1 — iOS, 3 — Android, 7 — Mac OS X, 8 — Windows, 9 — Amazon, 10 — Safari, 11 — Chrome, 12 — Firefox, 14 — Email, 17 — Huawei, 18 — SMS, et 21 — WhatsApp.

Code d’un Preset créé dans le Control Panel de Pushwoosh ou via l’API. Pour obtenir un code de Preset, allez dans Content → Presets, développez le preset que vous allez utiliser et copiez le Preset Code à partir des détails du preset.

Code d’une page Rich Media que vous allez joindre à votre message. Pour obtenir un code, allez dans Content → Rich Media, ouvrez la page Rich Media que vous allez utiliser, et copiez le code depuis la barre d’URL de votre navigateur. Le code est un ensemble de 10 caractères (lettres et chiffres) séparés par des tirets.

Limitation du débit (throttling) pour restreindre la vitesse d’envoi des pushes. Les valeurs valides sont de 100 à 1000 pushes/seconde.

Fuseau horaire à prendre en compte lorsque le message est envoyé à une date et une heure particulières. S’il est défini, le fuseau horaire de l’appareil est ignoré. S’il est ignoré, le message est envoyé en UTC-0. Voir https://php.net/manual/timezones.php pour les fuseaux horaires pris en charge.

Variables (placeholders) de modèle à utiliser dans votre modèle de contenu. Consultez le guide des Liquid Templates pour plus de détails.

Identifiant de message unique pour éviter la duplication des messages en cas de problèmes de réseau. Vous pouvez assigner n’importe quel ID à un message créé via une requête /createMessage ou /createTargetedMessage. Conservé du côté de Pushwoosh pendant 5 minutes.

Un tableau de User ID. Le User ID est un identifiant utilisateur unique défini par une requête API /registerUser, /registerDevice ou /registerEmail.