API Messages

{
  "request": {
    "application": "XXXXX-XXXXX",       // requis. Code d'application Pushwoosh.
    "auth": "yxoPUlwqm…………pIyEX4H",     // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh.
    "notifications": [{
      "send_date": "now",               // optionnel. AAAA-MM-JJ HH:mm OU 'now'
      "content": {                      // optionnel. objet OU chaîne.
        "en": "English",                //           Utilisez "wns_content" à la place pour Windows.
        "fr": "French"
      },
      "title": {                        // optionnel. objet OU chaîne.
        "en": "Title",                  //           Ignoré si des titres spécifiques à la plateforme sont spécifiés
        "fr": "Titre"                   //           'ios_title', 'android_header', etc.
      },                                //           voir les exemples de paramètres spécifiques à la plateforme ci-dessous.
      "subtitle":{                      // optionnel. objet OU chaîne.
        "en": "Subtitle",               //           Ignoré si des titres spécifiques à la plateforme sont spécifiés
        "fr": "Sous-titre"              //           'ios_subtitle', etc.
      },                                //           voir les exemples de paramètres spécifiques à la plateforme ci-dessous.
      "ignore_user_timezone": true,     // optionnel.
      "timezone": "America/New_York",   // optionnel. Si ignoré, UTC-0 est la valeur par défaut pour "send_date".
                                        //           Voir https://php.net/manual/timezones.php pour
                                        //           les fuseaux horaires pris en charge.
      "campaign": "CAMPAIGN_CODE",      // optionnel. Code de campagne auquel vous souhaitez
                                        //           assigner ce message push.
      "geozone": {                      // optionnel. Envoyer à la Geozone
        "lat": 22.22,
        "lng": 33.33,
        "range": 110
      },
      "rich_media": "XXXXX-XXXXX",      // optionnel. Copiez le code du Rich Media depuis la barre d'URL de
                                        //           la page de l'éditeur Rich Media dans le Control Panel de Pushwoosh.
      "link": "https://google.com",     // optionnel. Pour les deep links, ajoutez "minimize_link": 0
      "minimize_link": 0,               // optionnel. 0 — ne pas minimiser, 2 — bitly. Par défaut = 2.
                                        //           Veuillez noter que les raccourcisseurs ont des restrictions
                                        //           sur le nombre d'appels.
      "data": {                         // optionnel. Chaîne JSON ou objet JSON, sera passé comme
        "key": "value"                  //           paramètre "u" dans le payload (converti en chaîne JSON).
      },
      "transactionId": "unique UUID",   // optionnel. Identifiant de message unique pour éviter la duplication
                                        //           en cas de problèmes réseau. Stocké du côté de
                                        //           Pushwoosh pendant 5 minutes.
      "platforms": [                    // optionnel. 1 — iOS ; 3 — Android ; 7 — Mac OS X ; 8 — Windows ;
        1, 3, 7, 8, 9, 10,              //           9 — Amazon ; 10 — Safari ; 11 — Chrome ;
        11, 12, 17                      //           12 — Firefox ; 17 — Huawei
      ],
      "preset": "XXXXX-XXXXX",          // optionnel. Code de préréglage de push depuis votre Control Panel.
                                        //           Si des paramètres spécifiques sont envoyés dans la requête,
                                        //           ils remplacent les paramètres du préréglage.
      "send_rate": 100,                 // optionnel. Limitation. Les valeurs valides sont de 100 à 1000 pushes/seconde.

      // Relatif aux modèles, veuillez vous référer au guide du moteur de modèles pour en savoir plus
      "template_bindings": {            // optionnel.
        "TemplatePlaceholder": "Value"
      },
      "dynamic_content_placeholders": { // optionnel. Variables pour le contenu dynamique au lieu des tags d'appareil.
        "firstname": "John",
        "lastname": "Doe"
      },

      // Paramètres de limitation de fréquence. Assurez-vous que la limitation de fréquence globale est configurée dans le Control Panel.
      "capping_days": 30,               // optionnel. Nombre de jours pour la limitation de fréquence (max 30 jours)
      "capping_count": 10,              // optionnel. Le nombre maximal de pushes pouvant être envoyés d'une
                                        //           application spécifique à un appareil particulier dans une période de 'capping_days'
                                        //           . Si le message créé dépasse la limite
                                        //           'capping_count' pour un appareil, il ne sera
                                        //           pas envoyé à cet appareil.
      "capping_exclude": true,          // optionnel. Si défini sur true, cette notification push ne sera
                                        //           pas comptabilisée pour la limitation des futurs pushes.
      "capping_avoid": true,            // optionnel. Si défini sur true, la limitation ne s'appliquera pas à
                                        //           cette notification push spécifique.

      // Pour enregistrer le message dans la boîte de réception via l'API, utilisez "inbox_date" ou "inbox_image".
      // Le message est enregistré si au moins un de ces paramètres est utilisé.
      "inbox_date": "2017-02-02",       // optionnel. Spécifiez quand supprimer un message de la boîte de réception.
                                        //           Le message sera supprimé de la boîte de réception à 00:00:01 UTC
                                        //           à la date spécifiée, donc la date précédente est le
                                        //           dernier jour où un utilisateur peut voir le message dans sa boîte de réception.
                                        //           Si non spécifié, la date de suppression par défaut est le
                                        //           jour suivant la date d'envoi.
      "inbox_image": "Inbox image URL", // optionnel. L'image à afficher à côté du message.
    "inbox_days": 5,                  // optionnel. Spécifiez quand supprimer un message de la
                                        //           boîte de réception (durée de vie d'un message de boîte de réception en jours).
                                        //           Peut être utilisé à la place du paramètre "inbox_date".
                                        //           Jusqu'à 30 jours.

      "devices": [                      // optionnel. Spécifiez des jetons ou des hwids pour envoyer des notifications push ciblées
          "hwid_XXXX"                   //           . Pas plus de 1000 jetons/hwids dans
      ],                                //           un tableau. S'il est défini, le message ne sera envoyé qu'aux
                                        //           appareils de la liste. Le groupe d'applications pour la liste d'appareils
                                        //           n'est pas autorisé. Les jetons push iOS ne peuvent être qu'en minuscules.

      // Notifications push centrées sur l'utilisateur
      "users": [                        // optionnel. Si défini, le message ne sera livré qu'aux
          "user_XXXX"                   //           ID utilisateur spécifiés (définis via l'appel /registerUser).
      ],                                //           S'il est spécifié avec le paramètre devices,
                                        //           ce dernier sera ignoré. Pas plus de 1000
                                        //           ID utilisateur dans un tableau. Le groupe d'applications pour la liste d'utilisateurs
                                        //           n'est pas autorisé.

      // Filtres et conditions
      "filter": "FILTER_NAME",          // optionnel.
      "conditions": [                   // optionnel. Voir la remarque ci-dessous.
        "Country", "EQ", "France",
        "Language", "EQ", "en"
      ],
      "conditions_operator": "AND"      // optionnel. Opérateur logique pour les tableaux de conditions.
                                        //           Valeurs possibles : AND | OR. AND est la valeur par défaut.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",         // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",       // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "ios_title": {                      // optionnel. Objet OU chaîne. Ajoute un titre spécifique à iOS pour la notification push.
        "en": "title"
      },
      "ios_subtitle": {                   // optionnel. Objet OU chaîne. Ajoute un sous-titre spécifique à iOS pour la notification push.
        "en": "subtitle"
      },
      "ios_content": {                    // optionnel. Objet OU chaîne. Ajoute un contenu spécifique à iOS pour la notification push.
        "en": "content"
      },
      "ios_badges": 5,                    // optionnel. Numéro de badge de l'application iOS.
                                          //           Utilisez "+n" ou "-n" pour incrémenter/décrémenter la valeur du badge de n.
      "ios_sound": "sound file.wav",      // optionnel. Nom du fichier son dans le bundle principal de l'application.
                                          //           Si laissé vide, l'appareil produira un son système par défaut.
      "ios_sound_off": true,              // optionnel. Activer/désactiver le son défini par le champ "ios_sound".
      "ios_ttl": 3600,                    // optionnel. Paramètre de durée de vie - durée de vie maximale du message en secondes.
      "ios_silent": 1,                    // optionnel. Active les notifications silencieuses (ignore "sound" et "content").
      "ios_category_id": "1",             // optionnel. ID de catégorie iOS8 de Pushwoosh.
      "ios_root_params": {                // optionnel. Paramètres de niveau racine pour le dictionnaire aps.
        "aps": {
          "content-available": "0",       // optionnel. Définir sur "1" pour envoyer un push silencieux et "0" pour un push normal.
          "mutable-content": 1            // requis pour les pièces jointes multimédias iOS10+.
        },
        "data": {}                        // optionnel. Données fournies par l'utilisateur, max 4 Ko.
      },
      "ios_attachment": "URL",            // optionnel. Insérer du contenu multimédia dans la notification.
      "ios_thread_id": "some thread id",  // optionnel. Identifiant pour regrouper les notifications associées.
                                          //           Les messages avec le même ID de fil de discussion seront regroupés
                                          //           sur l'écran de verrouillage et dans le Centre de notifications.
      "ios_critical": true,               // optionnel. Marque la notification iOS comme une alerte critique
                                          //           qui joue un son même si l'appareil est en sourdine ou
                                          //           que le mode Ne pas déranger est activé.
      "ios_category_custom": "category",  // optionnel. Catégorie APNS personnalisée.
      "ios_interruption_level": "active", // optionnel. Un de "passive", "active", "time-sensitive",
                                          //           "critical". Indique l'importance et
                                          //           le moment de livraison d'une notification. Référez-vous au
                                          //           guide des pushes uniques pour plus de détails.
      "apns_trim_content": 1              // optionnel. (0|1) Tronque les chaînes de contenu trop longues avec des points de suspension.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",            // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",          // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "android_header": {                    // optionnel. En-tête de notification Android.
        "en": "header"
      },
      "android_content": {                   // optionnel. Contenu de la notification Android.
        "en": "content"
      },
      "android_root_params": {               // optionnel. Objet clé-valeur personnalisé.
        "key": "value",                      //           Paramètres de niveau racine pour les destinataires du payload android.
        "CancelID": 12345678                 // optionnel. Annule la notification push avec l'ID de message spécifié
      },                                     //           (obtenez l'ID depuis l'historique des messages)
      "android_sound": "soundfile",          // optionnel. Pas d'extension de fichier. Si laissé vide,
                                             //           l'appareil produira un son système par défaut.
      "android_sound_off": true,             // optionnel. Activer/désactiver le son défini par le champ "android_sound"
      "android_icon": "icon.png",            // optionnel.
      "android_custom_icon": "URL.png",      // optionnel. URL complète du fichier image.
      "android_banner": "URL.png",           // optionnel. URL complète du fichier image.
      "android_badges": 5,                   // optionnel. Numéro de badge de l'icône de l'application Android.
                                             //           Utilisez "+n" ou "-n" pour incrémenter/décrémenter la valeur du badge de n.
      "android_gcm_ttl": 3600,               // optionnel. Paramètre de durée de vie — durée de vie maximale du message en secondes.
      "android_vibration": 0,                // optionnel. Vibration forcée sur Android pour les pushes à haute priorité.
      "android_led": "#rrggbb",              // optionnel. Couleur LED hexadécimale, l'appareil fera sa meilleure approximation.
      "android_priority": -1,                // optionnel. Définit le paramètre "importance" pour les appareils avec
                                             //           Android 8.0 et supérieur, ainsi que le paramètre "priority"
                                             //           pour les appareils avec Android 7.1 et inférieur. Établit le
                                             //           niveau d'interruption d'un canal de notification ou d'une notification
                                             //           particulière. Les valeurs valides sont -2, -1, 0, 1, 2.
      "android_delivery_priority": "normal", // optionnel. "normal" ou "high".
                                             //           Permet la livraison de la notification lorsque
                                             //           l'appareil est en mode d'économie d'énergie.
      "android_ibc": "#RRGGBB",              // optionnel. couleur de fond de l'icône sur Lollipop, #RRGGBB,
                                             //           #AARRGGBB, "red", "black", "yellow", etc.
      "android_silent": 1,                   // optionnel. 0 ou 1. Activer la notification silencieuse.
                                             //           Ignorer le son et le contenu
      "android_group_id": "123"              // optionnel. Identifiant pour regrouper les notifications associées. Les messages avec
                                             //           le même ID de fil de discussion seront regroupés dans
                                             //           le Centre de notifications.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",                   // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",                 // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "huawei_android_header": {                    // optionnel. Objet OU chaîne. Titre de la notification
        "en": "header"
      },
      "huawei_android_content": {                   // optionnel. Objet OU chaîne. Contenu de la notification
        "en": "content"
      },
      "huawei_android_badges": true,                // optionnel.
      "huawei_android_silent": 0,                   // optionnel. 0 ou 1. Activer la notification silencieuse.
                                                    //           Ignorer le son et le contenu
      "huawei_android_icon": "URL.png",             // optionnel.
      "huawei_android_led": "#FF0011",              // optionnel. Couleur LED hexadécimale, l'appareil fera sa meilleure approximation
      "huawei_android_vibration": 1,                // optionnel. Vibration forcée sur Huawei pour les pushes à haute priorité
      "huawei_android_sound": "sound.wav",          // optionnel. Si laissé vide, l'appareil produira
                                                    //           un son système par défaut
      "huawei_android_sound_off": true,             // optionnel. Activer/désactiver le son défini par
                                                    //           le champ "huawei_android_sound"
      "huawei_android_custom_icon": "URL.png",      // optionnel
      "huawei_android_gcm_ttl": 2400,               // optionnel. Paramètre de durée de vie - maximum
                                                    //           durée de vie du message en secondes
      "huawei_android_banner": "URL.png",           // optionnel. URL complète du fichier image
      "huawei_android_root_params": {               // optionnel. Objet clé-valeur personnalisé.
        "key": "value"                              //           Paramètres de niveau racine pour les destinataires du payload Huawei.
      },
      "huawei_android_priority": 0,                 // optionnel. Valeurs valides : -2, -1, 0, 1, 2
      "huawei_android_ibc": "#0011AA",              // optionnel. Couleur de fond de l'icône sur Lollipop
      "huawei_android_lockscreen": 1,               // optionnel
      "huawei_android_delivery_priority": "normal", // optionnel. "normal" ou "high". Permet la livraison
                                                    //           de la notification en mode d'économie d'énergie
      "huawei_android_group_id": "group_id"         // optionnel. Identifiant pour regrouper les notifications associées
    }]
  }
}

{
  "request": {
    "application": "12345-67891",    // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",  // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "safari_url_args": [           // requis, mais la valeur peut être vide
        "firstArgument",
        "secondArgument"
      ],
      "safari_title": {              // optionnel. Objet OU chaîne. Titre de la notification.
        "en": "content"
      },
      "safari_content": {            // optionnel. Objet OU chaîne. Contenu de la notification.
        "en": "content"
      },
      "safari_action": "Click here", // optionnel.
      "safari_ttl": 3600             // optionnel. Paramètre de durée de vie — la durée de vie
                                     //           maximale d'un message en secondes.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",          // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H",        // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "chrome_title": {                    // optionnel. Objet OU chaîne. Vous pouvez spécifier l'en-tête
        "en": "title"                      //           du message dans ce paramètre.
      },
      "chrome_content": {                  // optionnel. Objet OU chaîne. Vous pouvez spécifier le contenu
        "en": "content"                    //           du message dans ce paramètre.
      },
      "chrome_icon": "URL.png",            // optionnel. URL complète de l'icône ou chemin du fichier de ressources de l'extension
      "chrome_gcm_ttl": 3600,              // optionnel. Paramètre de durée de vie – durée de vie maximale du message en secondes.
      "chrome_duration": 20,               // optionnel. max 50 secondes. Modifie la durée d'affichage du push Chrome.
                                           //           Mettre à 0 pour afficher le push jusqu'à ce que l'utilisateur interagisse avec.
      "chrome_image": "image_URL",         // optionnel. URL vers une grande image.
      "chrome_root_params": {              // optionnel. Définir des paramètres spécifiques aux messages envoyés à Chrome.
        "key": "value"
      },
      "chrome_button_text1": "text1",      // optionnel
      "chrome_button_url1": "button1_URL", // optionnel. Ignoré si chrome_button_text1 n'est pas défini.
      "chrome_button_text2": "text2",      // optionnel
      "chrome_button_url2": "button2_url"  // optionnel. Ignoré si chrome_button_text2 n'est pas défini.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "firefox_title": {            // optionnel. Objet OU chaîne. Vous pouvez spécifier l'en-tête du message ici.
        "en": "title"
      },
      "firefox_content": {          // optionnel. Objet OU chaîne. Vous pouvez spécifier le contenu du message ici.
        "en": "content"
      },
      "firefox_icon": "URL.png",    // optionnel. URL complète de l'icône ou chemin vers le
                                    //           fichier dans les ressources de l'extension.
      "firefox_root_params": {      // optionnel. Définir des paramètres spécifiques aux messages envoyés à Firefox.
        "key": "value"
      }
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "adm_header": {               // optionnel. Objet OU chaîne. Vous pouvez spécifier l'en-tête du message ici.
        "en": "header"
      },
      "adm_content": {              // optionnel. Objet OU chaîne. Vous pouvez spécifier le contenu du message ici.
        "en": "content"
      },
      "adm_root_params": {          // optionnel. Objet clé-valeur personnalisé
        "key": "value"
      },
      "adm_sound": "push.mp3",      // optionnel.
      "adm_sound_off": true,        // optionnel. Activer/désactiver le son défini par le champ "adm_sound"
      "adm_icon": "icon.png",       // optionnel. URL complète de l'icône.
      "adm_custom_icon": "URL.png", // optionnel.
      "adm_banner": "URL.png",      // optionnel.
      "adm_ttl": 3600,              // optionnel. Paramètre de durée de vie — la durée de vie maximale du message
                                    //           en secondes.
      "adm_priority": -1            // optionnel. Priorité du push dans le tiroir de push Amazon,
                                    //           les valeurs valides sont -2, -1, 0, 1 et 2.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "mac_title": {                // optionnel. Objet OU chaîne. Ajoute un titre pour la notification push.
        "en": "title"
      },
      "mac_subtitle": {             // optionnel. Ajoute un sous-titre pour la notification push.
        "en": "subtitle"
      },
      "mac_content": {              // optionnel. Ajoute un contenu pour la notification push.
        "en": "content"
      },
      "mac_badges": 3,              // optionnel.
      "mac_sound": "sound.caf",     // optionnel.
      "mac_sound_off": true,        // optionnel. Activer/désactiver le son défini par le champ "mac_sound"
      "mac_root_params": {          // optionnel.
        "content-available": 1
      },
      "mac_ttl": 3600               // optionnel. Paramètre de durée de vie — durée de vie maximale du message en secondes.
    }]
  }
}

{
  "request": {
    "application": "12345-67891",   // requis. Code d'application Pushwoosh
    "auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "notifications": [{
      "wns_content": {              // requis. Contenu (XML ou brut) de la notification encodé en base64 MIME
                                    //           sous forme d'objet OU de chaîne
        "en": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9ImF2YWlsYWJsZSIvPg==",
        "de": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9Im5ld01lc3NhZ2UiLz4="
      },
      "wns_type": "Badge",          // optionnel. 'Tile' | 'Toast' | 'Badge' | 'Raw'
      "wns_tag": "myTag",           // optionnel. Utilisé dans la politique de remplacement des tuiles.
                                    //           Une chaîne alphanumérique de 16 caractères maximum.
      "wns_cache": 1,               // optionnel. (1|0) Se traduit par la valeur X-WNS-Cache-Policy.
      "wns_ttl": 600                // optionnel. Durée d'expiration de la notification en secondes.
    }]
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",  // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "message": "xxxx-xxxxxxx-xxxxxx" // requis. Code du message obtenu dans /createMessage
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H",  // requis. Jeton d'accès API depuis le Control Panel de Pushwoosh
    "message": "xxxx-xxxxxxx-xxxxxx" // requis. code du message ou ID du message
  }
}