Geozones API

getNearestZone

SDK से आंतरिक रूप से कॉल किया जाता है। निकटतम geozone के पैरामीटर और उससे दूरी को पुनर्प्राप्त करता है। जियो पुश नोटिफिकेशन के लिए डिवाइस लोकेशन भी रिकॉर्ड करता है।

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

Request body parameters

Parameter	Type	Required	Description
application	string	Yes	Pushwoosh एप्लिकेशन कोड
hwid	string	Yes	हार्डवेयर डिवाइस ID जिसका उपयोग /registerDevice अनुरोध में किया गया है।
lat	string	Yes	डिवाइस का Latitude (अक्षांश)।
lng	string	Yes	डिवाइस का Longitude (देशांतर)।

Request example

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

PHP example

// See http://gomoob.github.io/php-pushwoosh/get-nearest-zone.html

use Gomoob\Pushwoosh\Model\Request\GetNearestZoneRequest;

// Creates the request instance
$request = GetNearestZoneRequest::create()
    ->setHwid('HWID')
    ->setLat(10.12345)
    ->setLng(28.12345);

// Call the '/getNearestZone' Web Service
$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

एक विशिष्ट ऐप में Geozone जोड़ता है।

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

Request body parameters

Parameter	Type	Required	Description
auth	string	Yes	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application	string	Yes	Pushwoosh एप्लिकेशन कोड
geozones	array	Yes	JSON array के रूप में Geozone पैरामीटर।
geozones.name	string	Yes	Geozone का नाम।
geozones.lat	string	Yes	Geozone का Latitude (अक्षांश)।
geozones.lng	string	Yes	Geozone का Longitude (देशांतर)।
geozones.cooldown	integer	Yes	नोटिफिकेशन भेजने के बाद साइलेंट पीरियड (सेकंड में)।
geozones.range	integer	Yes	Geozone रेंज (मीटर में, 50 से 1000 तक)।
geozones.content	string or object	Required if presetCode is empty.	Geozone संदेश सामग्री (content)।
geozones.presetCode	string	Required if content is empty.	content के बजाय उपयोग करने के लिए Push preset।
geozones.cluster	string	No	Geozone से क्लस्टर को अनबाइंड (unbind) करने के लिए null निर्दिष्ट करें।
geozones.campaign	string	No	Geozone से अभियान (campaign) को अनबाइंड करने के लिए null निर्दिष्ट करें। यदि छोड़ दिया जाता है, तो अभियान का मान अपरिवर्तित रहता है। नोट: प्रीसेट में अभियान की तुलना में इसकी प्राथमिकता अधिक है।
geozones.timetable	object	No	समय सारिणी (timetable) अंतराल सेट करता है।

Request example

{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX",            // Pushwoosh application code
    "geozones": [{
      "name": "Statue of George",            // required. Geozone name.
      "lat": "40.70087797",                   // required. Geozone latitude.
      "lng": "-73.931851387",                 // required. Geozone longitude.
      "cooldown": 60,                         // in seconds, required. Silent period after sending a notification
      "range": 50,                            // in meters, from 50 to 1000, required. Range of the geozone.
      "content": "Lorem ipsum dolor sit amet,
       consectetur adipiscing elit.",         // or object
      "presetCode": "AAAAA-BBBBB",            // optional. Push preset could be used instead of content
      "cluster": "GEOZONE CLUSTER CODE",      // optional. Cluster's cooldown period will be applied
      "campaign": "CAMPAIGN_CODE",            // optional. Specify null to unbind Campaign from Geozone
      "timetable": {                          // optional
        "timezone": 1234,                     // in seconds
        "Mon": [                              // available days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Push sending
          {
            "start": "04:11",
            "stop": "12:00"
          }
        ],
        "Sun": [
          {                                    // one or two intervals
            "start": "01:11",
            "stop": "17:00"
          },
          {
            "start": "18:01",
            "stop": "23:59"
          }
        ]
      }
    }]
  }
}

updateGeoZone

Geozone गुणों (properties) को अपडेट करता है।

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

Request body parameters

Parameter	Type	Required	Description
auth	string	Yes	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
geoZoneId	string	Yes	/addGeoZone अनुरोध से Geozone ID।
name	string	No	नया Geozone नाम।
cooldown	integer	No	अपडेट करने के लिए Cooldown, सेकंड में।
status	integer	No	0 - निष्क्रिय (deactivated), 1 - सक्रिय (activated)।
content	string	No	Geozone पुश नोटिफिकेशन के लिए सामग्री। presetCode के साथ उपयोग नहीं किया जा सकता।
cluster	string	No	नया क्लस्टर नाम। Geozone से क्लस्टर को अनबाइंड करने के लिए null निर्दिष्ट करें।
campaign	string	No	नया अभियान (campaign) ID। Geozone से अभियान को अनबाइंड करने के लिए null निर्दिष्ट करें। यदि छोड़ दिया जाता है, तो अभियान मान नहीं बदला जाएगा। प्रीसेट से अभियान की तुलना में इसकी प्राथमिकता अधिक है।
lat	number	No	Geozone Latitude (अक्षांश)।
lng	number	No	Geozone Longitude (देशांतर)।
range	integer	No	मीटर में नई रेंज।
timetable	object	No	Geozone समय सारिणी (timetable)। अधिक जानकारी नीचे देखें।

---

Request example

{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // required, API access token from Pushwoosh Control
    "geoZoneId": 100016750,                  // required, from /addGeoZone method
    "name": "new geozone name",              // optional
    "cooldown": 222,                         // in seconds, optional
    "status": 0,                             // optional, 0 - deactivated, 1 - activated
    "presetCode": "BBBBB-AAAAA",             // optional, cannot be used along with "content"
    "content": "new geozone content",        // optional, cannot be used along with "presetCode"
    "cluster": "GEOZONE CLUSTER CODE",       // optional. Specify null to unbind cluster from Geozone
    "campaign": "CAMPAIGN_CODE",             // optional. Specify null to unbind Campaign from Geozone
    "lat": 10.56,                            // optional, geozone latitude
    "lng": 12.523,                           // optional, geozone longitude
    "range": 500,                            // optional, geozone range
    "timetable": {                           // optional
      "timezone": 1234,                      // in seconds
      "Mon": [                               // available days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Push sending
        {
          "start": "04:11",
          "stop": "12:00"
        }
      ],
      "Sun": [
        {                                    // one or two intervals
          "start": "01:11",
          "stop": "17:00"
        },
        {
          "start": "18:01",
          "stop": "23:59"
        }
      ]
    }
  }
}

deleteGeoZone

ऐप से Geozones को हटाता है।

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

Request body parameters

Parameter	Type	Required	Description
auth	string	Yes	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application	string	Yes	Pushwoosh एप्लिकेशन कोड
geozones	string	Yes	IDs का Array या हटाने के लिए Geozone की एकल ID।

Request example

{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // required, API access token from Pushwoosh Control
    "application": "XXXXX-XXXXX",            // required, Pushwoosh application code
    "geozones": [550, 526]                   // required, geozones IDs
  }
}

addGeoZoneCluster

ऐप में Geozone Cluster जोड़ता है।

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

Request body parameters

Parameter	Type	Required	Description
auth	string	Yes	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application	string	Yes	Pushwoosh एप्लिकेशन कोड
name	string	Yes	क्लस्टर का नाम।
cooldown	integer	Yes	Geozone Cluster से एक ही उपयोगकर्ता को वही संदेश प्राप्त करने से पहले की देरी (delay), सेकंड में।

Request example

{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // required, API access token from Pushwoosh Control
    "application": "XXXXX-XXXXX",            // required, Pushwoosh application code
    "name": "Raccoon city",                  // required, cluster name
    "cooldown": 3210                         // required, in seconds
  }
}

deleteGeoZoneCluster

ऐप से Geozone Cluster को हटाता है।

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

Request body parameters

Parameter	Type	Required	Description
auth	string	Yes	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application	string	Yes	Pushwoosh एप्लिकेशन कोड
geoZoneCluster	string	Yes	हटाने के लिए Geozone cluster की ID।

Request example

{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // required, API access token from Pushwoosh Control
    "application": "XXXXX-XXXXX",            // required, Pushwoosh application code
    "geoZoneCluster": "EA1CE-69405"          // required, cluster ID obtained from the /addGeoZoneCluster request
  }
}

listGeoZones

ऐप के लिए Geozones की सूची पुनर्प्राप्त करता है।

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

Request body parameters

Parameter	Type	Required	Description
auth	string	Yes	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application	string	Yes	Pushwoosh एप्लिकेशन कोड

Request example

{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // required, API access token from Pushwoosh Control
    "application": "XXXXX-XXXXX"             // required, Pushwoosh application code
  }
}

listGeoZoneClusters

ऐप के लिए Geozone clusters की सूची पुनर्प्राप्त करता है।

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

Request body parameters

Parameter	Type	Required	Description
auth	string	Yes	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application	string	Yes	Pushwoosh एप्लिकेशन कोड

Request example

{
  "request": {
    "auth": "yxoPUlwqm............pIyEX4H",  // required, API access token from Pushwoosh Control
    "application": "XXXXX-XXXXX"             // required, Pushwoosh application code
  }
}