API Audience

bulkSetTags

POST https://api.pushwoosh.com/api/v2/audience/bulkSetTags

Définit les valeurs de tags pour la liste d’appareils.

Important

Lorsque vous utilisez la méthode bulkSetTags, assurez-vous que les valeurs de tags sont définies pour un minimum de 50 appareils. Pour définir des tags pour un seul appareil, utilisez la méthode setTags.

Corps de la requête

Nom	Type	Description
application*	String	Code d’application Pushwoosh
auth*	String	Jeton d’accès API depuis le Control Panel Pushwoosh.
create_missing_tags	Boolean	Si true, les tags manquants sont créés automatiquement.
devices*	Object	Tableau d’appareils.
devices.hwid	String	Peut être utilisé pour identifier un appareil au lieu de user_id ou push_token. En savoir plus
devices.user_id	String	Peut être utilisé pour identifier un utilisateur au lieu de hwid ou push_token. En savoir plus
devices.push_token	String	Peut être utilisé pour identifier un appareil au lieu de hwid ou user_id. En savoir plus
devices.list_operator	String	Définit comment définir les valeurs pour les tags de type liste : set, append ou remove
devices.tags*	Object	Valeurs à définir pour les tags spécifiés.

OK

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

Erreur

{
  "message": "invalid request"
}

Requête :

{
  "application": "application code",   // requis. Code d'application Pushwoosh
  "auth": "Pushwoosh auth token",      // requis. Jeton d'accès API depuis le Control Panel Pushwoosh
  "create_missing_tags": false,        // optionnel. Doit créer automatiquement les tags manquants
  "devices": [{                        // requis. Tableau d'appareils
    "hwid": "device hwid",             // optionnel. Peut être utilisé pour identifier un appareil au lieu de
                                       //           "user_id" ou "push_token".
    "user_id": "user ID",              // optionnel. Peut être utilisé pour identifier un utilisateur au lieu de "hwid" ou "push_token".
    "push_token": "device push token", // optionnel. Peut être utilisé pour identifier un appareil au lieu de "hwid" ou "user_id".
    "list_operator": "set",            // requis. Pour les tags de liste. Définit comment définir les valeurs pour
                                       //           les tags de type liste : set, append ou remove
    "tags": {                          // requis. Valeurs à définir pour les tags spécifiés.
      "tag_name": "tagvalue",          //           utilisez le type de valeur correct
      "tag_name2": "tagvalue2"
    }
  }]
}

Réponse :

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

Statut bulkSetTags

GET https://api.pushwoosh.com/api/v2/audience/bulkSetTags/{request_id}?detailed=false

Renvoie le statut de l’opération /bulkSetTags

Paramètres de chemin

Nom	Type	Description
request_id	String	id de requête de l’appel /bulkSetTags précédent

Paramètres de requête

Nom	Type	Description
detailed	Boolean	(true/false) si les informations détaillées par appareil doivent être renvoyées

Réponse :

{
  "request_id": "id of the request",
  "status": "Completed",          // aussi "Pending", "Failed"
  "progress": 100,                // progression des tâches 0-100
  "devices_success": 100,         // appareils valides
  "devices_not_found": 0,         // appareils non trouvés dans Pushwoosh
  "devices_failed": 0,            // en erreur
  "devices": [{                   // rapport d'appareil (seulement si detailed = true)
    "hwid": "device hwid",
    "status": "done",             // aussi "failed", "not found"
    "tags": {
      "tagName": "ok",
      "tagName2": "tag not found",
      "tagName3": "wrong value. expect :string"
    }
  }]
}

bulkRegisterDevice

Enregistre plusieurs appareils dans Pushwoosh en une seule requête. Cela permet également de spécifier divers tags pour chaque appareil.

POST https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice

Paramètres du corps de la requête

Paramètre	Type	Requis	Description
application	string	Oui	Code d’application Pushwoosh
auth	string	Oui	Jeton d’accès API.
devices	array	Oui	Un tableau d’objets d’appareil. Chaque objet représente un appareil et ses données associées. Voir les détails dans le tableau Paramètres de l’objet Device ci-dessous.

Paramètres de l’objet Device

Paramètre	Type	Requis	Description
hwid	string	Oui	L’ID matériel ou identifiant unique pour l’appareil.
push_token	string	Oui	Push token pour l’appareil.
platform	integer	Oui	L’identifiant de plateforme. En savoir plus
list_operator	string	Non	Détermine l’action pour les tags de type liste : - “append” : Ajoute la valeur spécifiée à la liste de tags. - “remove” : Supprime la valeur spécifiée de la liste de tags. Note : Si le paramètre list_operator n’est pas spécifié, toutes les valeurs existantes dans la liste de tags seront remplacées par les valeurs fournies.
tags	object	Non	Tags personnalisés assignés à l’appareil. Les tags sont des paires clé-valeur utilisées pour la segmentation.

Exemple de requête

Exemple :

{
  "application": "application code",   // requis. Code d'application Pushwoosh
  "auth": "Pushwoosh auth token",      // requis. Jeton d'accès API depuis le Control Panel Pushwoosh
  "devices": [{                        // requis. Tableau d'appareils
    "hwid": "device hwid",             // requis. Identifiant unique pour l'appareil (peut être un e-mail).
    "push_token": "device push token", // requis. Jeton de notification push pour l'appareil.
    "platform": 14,                    // requis. Plateforme de l'appareil (par ex. 14 pour e-mail).
    "list_operator": "append",         // optionnel. Pour les tags de liste. Ajoute ou supprime la/les valeur(s) spécifiée(s) du tag de type liste.
    "tags": {                          // optionnel. Valeurs à définir pour les tags spécifiés.
      "language": "en",                //           utilisez le type de valeur correct.
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // requis. Identifiant unique pour le deuxième appareil.
    "push_token": "device push token 2", // requis. Jeton de notification push pour l'appareil.
    "platform": 14,                    // requis. Plateforme de l'appareil.
    "list_operator": "remove",         // optionnel. Ajoute ou supprime des valeurs des tags de type liste.
    "tags": {                          // optionnel. Valeurs à supprimer des tags spécifiés.
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // requis. Identifiant unique pour le troisième appareil.
    "push_token": "device push token 3", // requis. Jeton de notification push pour l'appareil.
    "platform": 14,                    // requis. Plateforme de l'appareil.
    "tags": {                          // optionnel. Valeurs à définir pour les tags spécifiés.
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

Réponse

La méthode répond avec un ID d’opération, qui peut être utilisé pour suivre le statut et les résultats du processus d’enregistrement en masse.

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

Statut bulkRegisterDevice

Vous pouvez vérifier le statut d’un processus d’enregistrement en masse en effectuant la requête GET suivante :

GET https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice/{request_id}?detailed=true

Paramètre	Type	Requis	Description
request_id	string	Oui	L’ID de requête renvoyé par la requête POST.
detailed	boolean	Non	Si défini sur true, la réponse inclut des résultats détaillés pour chaque appareil enregistré.

Exemple de réponse

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}

bulkUnregisterDevice

Désinscrit plusieurs appareils de Pushwoosh en une seule requête.

POST https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice

Paramètres du corps de la requête

Paramètre	Type	Requis	Description
application	string	Oui	Code d’application Pushwoosh
auth	string	Oui	Jeton d’accès API
devices	array	Oui	Un tableau d’objets d’appareil. Chaque objet représente un appareil et ses données associées. Voir les détails dans le tableau Paramètres de l’objet Device ci-dessous.

Paramètres de l’objet Device

Paramètre	Type	Requis	Description
hwid	string	Oui	L’ID matériel ou identifiant unique pour l’appareil. En savoir plus

Exemple de requête

Exemple :

{
  "application": "application code",   // requis. Code d'application Pushwoosh
  "auth": "Pushwoosh auth token",      // requis. Jeton d'accès API depuis le Control Panel Pushwoosh
  "devices": [{                        // requis. Tableau d'appareils
    "hwid": "device hwid",             // requis. Identifiant unique pour l'appareil (peut être un e-mail).
  },
  {
    "hwid": "device hwid 2",           // requis. Identifiant unique pour le deuxième appareil.
  },
  {
    "hwid": "device hwid 3",           // requis. Identifiant unique pour le troisième appareil.
  }]
}

Réponse

La méthode répond avec un ID d’opération, qui peut être utilisé pour suivre le statut et les résultats du processus en masse.

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

Statut bulkUnregisterDevice

Vous pouvez vérifier le statut d’un processus de désinscription en masse en effectuant la requête GET suivante :

GET https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice/{request_id}?detailed=true

Paramètre	Type	Requis	Description
request_id	string	Oui	L’ID de requête renvoyé par la requête POST.
detailed	boolean	Non	Si défini sur true, la réponse inclut des résultats détaillés pour chaque appareil désinscrit.

Exemple de réponse

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}