API Appareil

registerDevice

POST https://api.pushwoosh.com/json/1.3/registerDevice

Appelée en interne depuis le SDK. Enregistre l’appareil pour l’application.

En-têtes de la requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token XXXX	Jeton d’API Appareil pour accéder à l’API Appareil. Remplacez XXXX par votre véritable jeton d’API Appareil.

Corps de la requête

Nom	Type	Description
application*	string	Code d’application Pushwoosh
push_token	string	Jeton push pour l’appareil.
language	string	Locale de langue de l’appareil. Doit être un code de deux lettres en minuscules selon la norme ISO-639-1.
hwid*	string	Chaîne unique pour identifier l’appareil (IDFV sur iOS, valeur générée aléatoirement sur Android). En savoir plus
timezone	integer	Décalage de fuseau horaire en secondes pour l’appareil.
device_type*	integer	Type d’appareil. Voir les valeurs possibles ci-dessous.
email	string	Adresse e-mail à enregistrer (à utiliser pour les utilisateurs d’e-mail au lieu de HWID et du jeton push).
tags	object	Valeurs de tag à assigner à l’appareil enregistré.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

Exemple

{
  "request": {
    "application": "XXXXX-XXXXX",        // required. Pushwoosh application code
    "push_token": "dec301908b9ba8XXXXX57a58e40f96f5XXXXX2068674f5XXXXa25cdc250a2a41", // optional.
    "hwid": "1CA6XXXXX-8DAC-XXXXX-XXXXX-B756288B6D3C",                                   // required. Hardware device ID
    "idfa": "AEBE52E7-0XXXXX-455A-XXXXX-E57283966239",                                   // optional.
    "timezone": 3600,                    // optional. Offset in seconds
    "device_type": 1,                    // required. See the possible values below. For emails,
                                         //           use the "emails" params as described below.
    "email": "email_address@domain.com", // use instead of "hwid" and "push_token" to register
                                         //           the email address for your email project
    "language": "en",                    // optional. ISO 639-1|639-2 language code
    "userId": "Alex",                    // optional.
    "tags": {                            // optional. Tag values to set for the device registered
      "StringTag": "string value",
      "IntegerTag": 42,
      "ListTag": ["string1", "string2"], // sets the list of values for Tags of List type
      "DateTag": "2024-10-02 22:11",     // note the time should be in UTC
      "BooleanTag": true                 // valid values are: true, false
    },

    // system tags, optionals
    "app_version": "1.2.3",
    "device_model": "Samsung SM-G355H",
    "os_version": "2.3",

    // optional encryption keys for chrome/firefox
    "public_key": "BNmDO4BTKEMJqaqprTf7t/HBXXXXX/orcXXXXX/scS5CFP6XXXXXHI1/GgRQD8c4kTxTEEF0quvIUiLQqoBY0/Qo=",
    "auth_token": "RlRmCXXXXX/s7XXXXXjKFzoQ==",

    // optional FCM keys for Chrome (for XMPP)
    "fcm_token": "BNmDO4BTKEMJXXXXXprTf7t/XXXXXBQ/orXXXXXc/scS5CFP6zhQGIHI1/GgRQD8c4kTxTEEF0quvIUiLQqoBY0/Qo=",
    "fcm_push_set": "RlXXXXXGM/s7XXXXXjKFzoQ=="
  }
}

Types d’appareils possibles :

• 1 – iOS
• 3 – Android
• 7 – Mac OS X
• 8 – Windows
• 9 – Amazon
• 10 – Safari
• 11 – Chrome
• 12 – Firefox
• 14 – E-mail
• 17 – Huawei
• 18 – SMS
• 21 – WhatsApp

Enregistrement des appareils e-mail

Pour enregistrer un abonné e-mail pour votre application, envoyez le paramètre "email": "email_address@domain.com" dans votre requête /registerDevice ou /registerEmail comme suit :

Exemple de requête

{
  "request":{
    "application": "XXXXX-XXXXX",        // required. Pushwoosh application code
    "email": "email_address@domain.com", // required. Email address to register for your email project
    "language": "en",                    // optional. ISO 639-1|639-2 language code
    "userId": "Alex",                    // optional.
    "tags": {                            // optional. Tag values to set for the device registered
      "StringTag": "string value",
      "IntegerTag": 42,
      "ListTag": ["string1", "string2"], // sets the list of values for Tags of List type
      "DateTag": "2024-10-02 22:11",     // note the time should be in UTC
      "BooleanTag": true                 // valid values are: true, false
    }
  }
}

Enregistrement des appareils WhatsApp

Pour enregistrer un appareil WhatsApp pour votre application, suivez ces directives :

• hwid : Assurez-vous que ce champ inclut le préfixe whatsapp: suivi du numéro de téléphone au format E.164 (par ex., whatsapp:+0000000000). Le numéro de téléphone doit être valide, ce que Pushwoosh vérifiera.

• Jeton push : Un jeton push n’est pas requis, car le hwid fonctionnera automatiquement comme jeton push.

• device_type : Définissez ce champ à 21 pour spécifier WhatsApp comme plateforme.

Exemple de requête

{
  "request": {
    "application": "XXXXX-XXXXX",        // required. Pushwoosh application code
    "hwid": "whatsapp:+0000000000",      // required. WhatsApp prefix and valid phone number
    "timezone": 3600,                    // optional. Time offset in seconds
    "device_type": 21,                   // required. WhatsApp device type is 21
    "language": "en",                    // optional. ISO 639-1|639-2 language code
    "userId": "Alex",                    // optional. User identifier
    "tags": {                            // optional. Tag values for custom segmentation
      "StringTag": "string value",
      "IntegerTag": 42,
      "ListTag": ["string1", "string2"],
      "DateTag": "2024-10-02 22:11",     // UTC format
      "BooleanTag": true
    },
    "app_version": "1.2.3",              // optional. Application version
    "device_model": "Samsung SM-G355H",  // optional. Device model
    "os_version": "2.3"                  // optional. Operating system version
  }
}

Enregistrement des appareils SMS

Pour enregistrer un appareil SMS pour votre application, suivez ces directives :

• hwid : Assurez-vous que ce champ inclut le numéro de téléphone au format E.164 (par ex., +0000000000). Le numéro de téléphone doit être valide, ce que Pushwoosh vérifiera.

• Jeton push : Un jeton push n’est pas requis, car le hwid fonctionnera automatiquement comme jeton push.

• device_type : Définissez ce champ requis à 18 pour désigner SMS comme plateforme.

Exemple de requête

{
   "request": {
      "application": "XXXXX-XXXXX",           // required. Pushwoosh application code
      "hwid": "+0000000000",                  // required. Valid phone number in E.164 format
      "timezone": 3600,                       // optional. Time offset in seconds
      "device_type": 18,                      // required. SMS device type is 18
      "language": "en",                       // optional. ISO 639-1|639-2 language code
      "userId": "Alex",                       // optional. User identifier
      "tags": {                               // optional. Tag values for custom segmentation
           "StringTag": "string value",
           "IntegerTag": 42,
           "ListTag": ["string1", "string2"],
           "DateTag": "2024-10-02 22:11",     // UTC format
           "BooleanTag": true
      },
      "app_version": "1.2.3",                 // optional. Application version
      "device_model": "Samsung SM-G355H",     // optional. Device model
      "os_version": "2.3"                     // optional. Operating system version
   }
}

Codes de statut :

Code de statut HTTP	status_code	Description
200	200	Appareil enregistré avec succès
200	210	Erreur d’argument. Voir status_message pour plus d’informations.
400	N/A	Chaîne de requête malformée
500	500	Erreur interne

unregisterDevice

POST https://api.pushwoosh.com/json/1.3/unregisterDevice

Supprime le jeton push de l’appareil. L’appareil désinscrit est toujours compté dans le Total des Appareils et peut être atteint avec les In-Apps. Appelée en interne depuis le SDK.

En-têtes de la requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token XXXX	Jeton d’API Appareil pour accéder à l’API Appareil. Remplacez XXXX par votre véritable jeton d’API Appareil.

Corps de la requête

Nom	Type	Description
application*	string	Code d’application Pushwoosh
hwid*	string	ID matériel de l’appareil utilisé dans la requête /registerDevice.

200

{
    "status_code": 200,
    "status_message": "OK",
    "response": null
}

Exemple

{
  "request": {
    "application": "XXXXX-XXXXX",              // required. Pushwoosh application code
    "hwid": "8f65b16XXXXXe7a6beceXXXXX530fb2"  // required. Hardware device ID used in /registerDevice API
  }
}

Note

Pour les e-mails, appelez /deleteEmail.

Codes de statut :

Code de statut HTTP	status_code	Description
200	200	Appareil désabonné avec succès
200	210	Erreur d’argument. Voir status_message pour plus d’informations.
400	N/A	Chaîne de requête malformée
500	500	Erreur interne

setTags

POST https://api.pushwoosh.com/json/1.3/setTags

Définit les valeurs des tags pour l’appareil. Appelée depuis le SDK.

En-têtes de la requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token XXXX	Jeton d’API Appareil pour accéder à l’API Appareil. Remplacez XXXX par votre véritable jeton d’API Appareil.

Corps de la requête

Nom	Type	Description
application*	string	Code d’application Pushwoosh
hwid*	string	ID matériel de l’appareil utilisé dans la requête /registerDevice.
tags*	object	Objet JSON des tags à définir, envoyez “null” pour supprimer la valeur.

200

{
   "status_code": 200,
   "status_message": "OK",
   "response": null
}

Note

La méthode est appelée depuis le SDK. Il est possible de l’appeler à distance depuis votre backend, cependant vous devez maintenir une base de données à jour des hwid du côté du backend.

Exemple

{
  "request":{
    "application": "XXXXX-XXXXX",               // required. Pushwoosh application code
    "hwid": "8f65b16XXXXXe7a6becXXXXXe1530fb2", // required. Hardware device ID used in /registerDevice API
    "tags": {                                   // required.
      "StringTag": "string value",
      "IntegerTag": 42,
      "ListTag": ["string1", "string2"],        // sets the list of values for Tags of List type
      "DateTag": "2024-10-02 22:11",            // note the time is in UTC
      "BooleanTag": true                        // valid values are - true, false
    }
  }
}

Incrémenter les valeurs de tag Entier

Pour incrémenter la valeur d’un tag Entier, utilisez le paramètre operation avec la valeur “increment” comme suit :

{
  "request":{
    "application": "12345-67890",                   // required. Pushwoosh application code
    "hwid": "21AB7628-XXXX-XXXX-CCC0-PO287CS24CA4", // required. hardware device ID used in /registerDevice API
    "tags": {                                       // required.
      "Level": {                                    // Tag name
        "operation": "increment",                   // overwrites the integer tag in increments of the following value
        "value": 1                                  // increment for the tag value
      }
    }
  }
}

Décrémenter les valeurs de tag Entier

Pour décrémenter, utilisez des nombres négatifs comme valeur pour l’opération “increment” (-1, -2, -3, -n) :

{
  "request":{
    "application": "12345-67890",                   // required. Pushwoosh application code
    "hwid": "21AB7628-XXXX-XXXX-CCC0-PO287CS24CA4", // required. Hardware device ID used in /registerDevice API
    "tags": {                                       // required
      "Level": {                                    // Tag name
        "operation": "increment",                   // overwrites the integer tag in decrement of the following value
        "value": -1                                 // decrement for the tag value
      }
    }
  }
}

Ajouter des valeurs de tag Liste

Pour étendre le tag Liste avec de nouvelles valeurs, utilisez le paramètre operation avec la valeur “append” comme suit :

Exemple

{
  "request": {
    "hwid": "3d124a79XXXXf189XXXX7dfd9XXXXafd", // required. Hardware device ID used in /registerDevice API
    "application": "6XXXX-XXXX3",               // required. Pushwoosh application code
    "tags": {                                   // required.
      "ListTag": {                              // Tag name
        "operation": "append",                  // appends following values to the Tag's list of values
        "value": [                              // values to append
          "tag2",
          "tag3"
        ]
      }
    }
  }
}

Supprimer des valeurs de tag Liste

Pour supprimer certaines valeurs du tag Liste, utilisez l’opération “remove” comme suit :

{
  "request":{
    "application": "12345-67890",                   // required. Pushwoosh application code
    "hwid": "21AB7628-XXXX-XXXX-CCC0-PO287CS24CA4", // required. Hardware device ID used in /registerDevice API
    "tags": {                                       // required.
      "In-App Product": {                           // Tag name
        "operation": "remove",                      // removes the following values from the list tag
        "value": "outwear_02"                       // value or values to remove
      }
    }
  }
}

Définir des tags par UserID

Pour définir des tags pour tous les appareils associés à un ID utilisateur particulier, utilisez le paramètre “userId” au lieu de “hwid”.

Attention

Assurez-vous que le tag pour lequel vous définissez des valeurs est spécifique à l’utilisateur.

Exemple

{
  "request":{
    "application": "AAAAA-BBBBB", // Pushwoosh app code
    "userId": "some_user",        // user ID you'd like to set tags for
    "tags": {                     // tags and values to set
      "Language": "es"
    }
  }
}

Note

Pour les e-mails, appelez /setEmailTags.

Codes de statut :

Code de statut HTTP	status_code	Description
200	200	Les tags ont été définis avec succès
200	210	Erreur d’argument. Voir status_message pour plus d’informations.
400	N/A	Chaîne de requête malformée
500	500	Erreur interne

getTags

POST https://api.pushwoosh.com/json/1.3/getTags

Récupère une liste de tags avec les valeurs correspondantes pour l’appareil spécifique.

En-têtes de la requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token XXXX	Jeton d’API Appareil pour accéder à l’API Appareil. Remplacez XXXX par votre véritable jeton d’API Appareil.

Corps de la requête

Nom	Type	Description
application*	string	Code d’application Pushwoosh
userId	string	ID utilisateur à utiliser à la place de “hwid”. S’il est utilisé avec un “hwid”, le “hwid” prévaut.
hwid	string	ID matériel de l’appareil utilisé dans la requête /registerDevice.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "result": {
      "Language": "fr"
    }
  }
}

Exemple

{
  "request":{
    "application": "XXXXX-XXXXX",   // required. Pushwoosh application code
    "hwid": "HWID",                 // optional. Hardware device ID used in /registerDevice API
    "userId": "USER_ID"             // optional. Can be used instead of "hwid" to retrieve tags for a specific user
  }
}

setBadge

POST https://api.pushwoosh.com/json/1.3/setBadge

Envoie la valeur actuelle du badge pour un appareil à Pushwoosh. Appelée en interne depuis le SDK.

En-têtes de la requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token XXXX	Jeton d’API Appareil pour accéder à l’API Appareil. Remplacez XXXX par votre véritable jeton d’API Appareil.

Corps de la requête

Nom	Type	Description
application*	string	Code d’application Pushwoosh
hwid*	string	ID matériel de l’appareil utilisé dans la requête /registerDevice.
badge*	integer	Badge actuel sur l’application.

200

{
  "status_code": 200,
  "status_message": "OK"
}

Exemple

{
  "request":{
    "application": "XXXXX-XXXXX",               // required. Pushwoosh application code
    "hwid": "8f65b16dXXXXe7a6XXXX9614XXXX0fb2", // required. Hardware device ID used in /registerDevice API
    "badge": 4                                  // required. Current badge on the application
  }
}

Appelée depuis le SDK en interne. Envoie la valeur actuelle du badge pour un appareil à Pushwoosh. Cela se produit en interne lorsque l’application modifie la valeur du badge sur un appareil iOS. Permet aux badges à incrémentation automatique de fonctionner correctement.

Attention

Cette méthode N’EST PAS utilisée pour mettre à jour la valeur du badge sur l’appareil. Veuillez plutôt utiliser la requête /createMessage avec le paramètre "ios_badges".

applicationOpen

POST https://api.pushwoosh.com/json/1.3/applicationOpen

Enregistre un événement d’ouverture d’application. Appelée en interne depuis le SDK.

En-têtes de la requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token XXXX	Jeton d’API Appareil pour accéder à l’API Appareil. Remplacez XXXX par votre véritable jeton d’API Appareil.

Corps de la requête

Nom	Type	Description
application*	string	Code d’application Pushwoosh
hwid*	string	ID matériel de l’appareil utilisé dans la requête /registerDevice.

200

{
  "status_code": 200,
  "status_message": "OK"
}

Exemple

{
  "request": {
    "application": "XXXXX-XXXXX",              // required. Pushwoosh application code
    "hwid": "8f65b16dXXXXe7a6XXXX9614eXXXXfb2" // required. Hardware device ID used in /registerDevice API
  }
}

pushStat

POST https://api.pushwoosh.com/json/1.3/pushStat

Enregistre un événement d’ouverture de push. Appelée en interne depuis le SDK.

En-têtes de la requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token XXXX	Jeton d’API Appareil pour accéder à l’API Appareil. Remplacez XXXX par votre véritable jeton d’API Appareil.

Corps de la requête

Nom	Type	Description
application*	string	Code d’application Pushwoosh
hwid*	string	ID matériel de l’appareil utilisé dans la requête /registerDevice.
userId	string	ID utilisateur à associer à l’événement d’ouverture de push.
hash	string	Tag de hachage reçu dans la notification push (paramètre “p” de la charge utile du push).

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

Exemple

{
  "request": {
    "application": "XXXXX-XXXXX",               // required. Pushwoosh application code
    "hwid": "8f65b16dfXXXX7a6beXXXX14e1530fb2", // required. Hardware device ID used in /registerDevice API
    "userId": "USER012345",                     // optional. The user id to associate with the push open event
    "hash": "HASH_TAG"                          // optional. Hash tag received in push notification
                                                //           ("p" parameter in the push payload)
  }
}

messageDeliveryEvent

POST https://api.pushwoosh.com/json/1.3/messageDeliveryEvent

Enregistre l’événement de livraison de push pour l’appareil. Appelée en interne depuis le SDK.

En-têtes de la requête

Nom	Requis	Valeur	Description
Authorization	Oui	Token XXXX	Jeton d’API Appareil pour accéder à l’API Appareil. Remplacez XXXX par votre véritable jeton d’API Appareil.

Corps de la requête

Nom	Type	Description
application*	string	Code d’application Pushwoosh
hwid*	string	ID matériel de l’appareil utilisé dans la requête /registerDevice.
hash	string	Tag de hachage reçu dans la notification push (paramètre “p” de la charge utile du push).

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

Exemple

 {
  "request": {
    "application": "XXXXX-XXXXX",               // required. Pushwoosh application code
    "hwid": "8f65b16dfXXXX7a6bece9XXXX1530fb2", // required. Hardware device ID used in /registerDevice API
    "hash": "HASH_TAG"                          // optional. Hash tag received in push notification
                                                //           ("p" parameter in the push payload)
  }
}