Passer au contenu
Guides utilisateurSupport Demander une démo Se connecter
Pushwoosh.com

API Géozones

getNearestZone

Anchor link to

Appelé en interne depuis le SDK. Récupère les paramètres de la géozone la plus proche et la distance jusqu’à celle-ci. Enregistre également la localisation de l’appareil pour les notifications push géolocalisées.

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

Paramètres du corps de la requête

Anchor link to
ParamètreTypeRequisDescription
applicationstringOuiCode d’application Pushwoosh
hwidstringOuiID matériel de l’appareil utilisé dans la requête /registerDevice.
latstringOuiLatitude de l’appareil.
lngstringOuiLongitude de l’appareil.

Exemple de requête

Anchor link to
{
  "request": {
    "application": "APPLICATION_CODE",
    "hwid": "HWID",
    "lat": 10.12345,
    "lng": 28.12345
  }
}

Exemple PHP

Anchor link to
// Voir http://gomoob.github.io/php-pushwoosh/get-nearest-zone.html


use Gomoob\Pushwoosh\Model\Request\GetNearestZoneRequest;


// Crée l'instance de requête
$request = GetNearestZoneRequest::create()
    ->setHwid('HWID')
    ->setLat(10.12345)
    ->setLng(28.12345);


// Appelle le service Web '/getNearestZone'
$response = $pushwoosh->getNearestZone($request);


if ($response->isOk()) {
    print 'Zone name : ' . $response->getResponse()->getName();
    print 'Latitude : ' . $response->getResponse()->getLat();
    print 'Longitude : ' . $response->getResponse()->getLng();
    print 'Range : ' . $response->getResponse()->getRange();
    print 'Distance : ' . $response->getResponse()->getDistance();
} else {
    print 'Oops, the operation failed :-(';
    print 'Status code : ' . $response->getStatusCode();
    print 'Status message : ' . $response->getStatusMessage();
}

addGeoZone

Anchor link to

Ajoute une Géozone à une application spécifique.

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

Paramètres du corps de la requête

Anchor link to
ParamètreTypeRequisDescription
authstringOuiJeton d’accès API du Panneau de configuration Pushwoosh.
applicationstringOuiCode d’application Pushwoosh
geozonesarrayOuiParamètres de la géozone sous forme de tableau JSON.
geozones.namestringOuiNom de la géozone.
geozones.latstringOuiLatitude de la géozone.
geozones.lngstringOuiLongitude de la géozone.
geozones.cooldownintegerOuiPériode de silence après l’envoi d’une notification (en secondes).
geozones.rangeintegerOuiPortée de la géozone (en mètres, de 50 à 1000).
geozones.contentstring or objectRequis si presetCode est vide.Contenu du message de la géozone.
geozones.presetCodestringRequis si content est vide.Préréglage Push à utiliser à la place de content.
geozones.clusterstringNonSpécifiez null pour dissocier un cluster de la Géozone.
geozones.campaignstringNonSpécifiez null pour dissocier une campagne de la Géozone. Si omis, la valeur de la campagne reste inchangée. Note : A une priorité plus élevée que la campagne dans le préréglage.
geozones.timetableobjectNonDéfinit les intervalles du calendrier.

Exemple de requête

Anchor link to
{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // Jeton d'accès API du Panneau de configuration Pushwoosh
    "application": "XXXXX-XXXXX",            // Code d'application Pushwoosh
    "geozones": [{
      "name": "Statue of George",            // requis. Nom de la géozone.
      "lat": "40.70087797",                   // requis. Latitude de la géozone.
      "lng": "-73.931851387",                 // requis. Longitude de la géozone.
      "cooldown": 60,                         // en secondes, requis. Période de silence après l'envoi d'une notification
      "range": 50,                            // en mètres, de 50 à 1000, requis. Portée de la géozone.
      "content": "Lorem ipsum dolor sit amet,
       consectetur adipiscing elit.",         // ou objet
      "presetCode": "AAAAA-BBBBB",            // optionnel. Un préréglage Push peut être utilisé à la place du contenu
      "cluster": "GEOZONE CLUSTER CODE",      // optionnel. La période de refroidissement du cluster sera appliquée
      "campaign": "CAMPAIGN_CODE",            // optionnel. Spécifiez null pour dissocier la Campagne de la Géozone
      "timetable": {                          // optionnel
        "timezone": 1234,                     // en secondes
        "Mon": [                              // jours disponibles : Mon, Tue, Wed, Thu, Fri, Sat, Sun. Envoi de push
          {
            "start": "04:11",
            "stop": "12:00"
          }
        ],
        "Sun": [
          {                                    // un ou deux intervalles
            "start": "01:11",
            "stop": "17:00"
          },
          {
            "start": "18:01",
            "stop": "23:59"
          }
        ]
      }
    }]
  }
}

updateGeoZone

Anchor link to

Met à jour les propriétés de la Géozone.

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

Paramètres du corps de la requête

Anchor link to
ParamètreTypeRequisDescription
authstringOuiJeton d’accès API du Panneau de configuration Pushwoosh.
geoZoneIdstringOuiID de Géozone depuis la requête /addGeoZone.
namestringNonNouveau nom de Géozone.
cooldownintegerNonPériode de refroidissement à mettre à jour, en secondes.
statusintegerNon0 - désactivé, 1 - activé.
contentstringNonContenu pour la notification push de Géozone. Ne peut pas être utilisé avec presetCode.
clusterstringNonNouveau nom de cluster. Spécifiez null pour dissocier le cluster de la Géozone.
campaignstringNonNouvel ID de campagne. Spécifiez null pour dissocier la Campagne de la Géozone. Si omis, la valeur de la Campagne ne sera pas modifiée. A une priorité plus élevée qu’une Campagne provenant d’un préréglage.
latnumberNonLatitude de la géozone.
lngnumberNonLongitude de la géozone.
rangeintegerNonNouvelle portée en mètres.
timetableobjectNonCalendrier de la Géozone. Voir plus d’informations ci-dessous.

Exemple de requête

Anchor link to
{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // requis, Jeton d'accès API du Panneau de configuration Pushwoosh
    "geoZoneId": 100016750,                  // requis, depuis la méthode /addGeoZone
    "name": "new geozone name",              // optionnel
    "cooldown": 222,                         // en secondes, optionnel
    "status": 0,                             // optionnel, 0 - désactivé, 1 - activé
    "presetCode": "BBBBB-AAAAA",             // optionnel, ne peut pas être utilisé avec "content"
    "content": "new geozone content",        // optionnel, ne peut pas être utilisé avec "presetCode"
    "cluster": "GEOZONE CLUSTER CODE",       // optionnel. Spécifiez null pour dissocier le cluster de la Géozone
    "campaign": "CAMPAIGN_CODE",             // optionnel. Spécifiez null pour dissocier la Campagne de la Géozone
    "lat": 10.56,                            // optionnel, latitude de la géozone
    "lng": 12.523,                           // optionnel, longitude de la géozone
    "range": 500,                            // optionnel, portée de la géozone
    "timetable": {                           // optionnel
      "timezone": 1234,                      // en secondes
      "Mon": [                               // jours disponibles : Mon, Tue, Wed, Thu, Fri, Sat, Sun. Envoi de push
        {
          "start": "04:11",
          "stop": "12:00"
        }
      ],
      "Sun": [
        {                                    // un ou deux intervalles
          "start": "01:11",
          "stop": "17:00"
        },
        {
          "start": "18:01",
          "stop": "23:59"
        }
      ]
    }
  }
}

deleteGeoZone

Anchor link to

Supprime des Géozones de l’application.

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

Paramètres du corps de la requête

Anchor link to
ParamètreTypeRequisDescription
authstringOuiJeton d’accès API du Panneau de configuration Pushwoosh.
applicationstringOuiCode d’application Pushwoosh
geozonesstringOuiTableau d’ID ou un ID unique d’une Géozone à supprimer.

Exemple de requête

Anchor link to
{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // requis, Jeton d'accès API du Panneau de configuration Pushwoosh
    "application": "XXXXX-XXXXX",            // requis, Code d'application Pushwoosh
    "geozones": [550, 526]                   // requis, IDs des géozones
  }
}

addGeoZoneCluster

Anchor link to

Ajoute un Cluster de Géozones à l’application.

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

Paramètres du corps de la requête

Anchor link to
ParamètreTypeRequisDescription
authstringOuiJeton d’accès API du Panneau de configuration Pushwoosh.
applicationstringOuiCode d’application Pushwoosh
namestringOuiNom du cluster.
cooldownintegerOuiUn délai avant qu’un utilisateur unique puisse recevoir le même message du Cluster de Géozones, en secondes.

Exemple de requête

Anchor link to
{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // requis, Jeton d'accès API du Panneau de configuration Pushwoosh
    "application": "XXXXX-XXXXX",            // requis, Code d'application Pushwoosh
    "name": "Raccoon city",                  // requis, nom du cluster
    "cooldown": 3210                         // requis, en secondes
  }
}

deleteGeoZoneCluster

Anchor link to

Supprime un Cluster de Géozones de l’application.

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

Paramètres du corps de la requête

Anchor link to
ParamètreTypeRequisDescription
authstringOuiJeton d’accès API du Panneau de configuration Pushwoosh.
applicationstringOuiCode d’application Pushwoosh
geoZoneClusterstringOuiID du cluster de Géozones à supprimer.

Exemple de requête

Anchor link to
{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // requis, Jeton d'accès API du Panneau de configuration Pushwoosh
    "application": "XXXXX-XXXXX",            // requis, Code d'application Pushwoosh
    "geoZoneCluster": "EA1CE-69405"          // requis, ID du cluster obtenu via la requête /addGeoZoneCluster
  }
}

listGeoZones

Anchor link to

Récupère une liste de Géozones pour l’application.

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

Paramètres du corps de la requête

Anchor link to
ParamètreTypeRequisDescription
authstringOuiJeton d’accès API du Panneau de configuration Pushwoosh.
applicationstringOuiCode d’application Pushwoosh

Exemple de requête

Anchor link to
{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // requis, Jeton d'accès API du Panneau de configuration Pushwoosh
    "application": "XXXXX-XXXXX"             // requis, Code d'application Pushwoosh
  }
}

listGeoZoneClusters

Anchor link to

Récupère une liste de clusters de Géozones pour l’application.

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

Paramètres du corps de la requête

Anchor link to
ParamètreTypeRequisDescription
authstringOuiJeton d’accès API du Panneau de configuration Pushwoosh.
applicationstringOuiCode d’application Pushwoosh

Exemple de requête

Anchor link to
{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // requis, Jeton d'accès API du Panneau de configuration Pushwoosh
    "application": "XXXXX-XXXXX"             // requis, Code d'application Pushwoosh
  }
}