Geozones API

getNearestZone

يتم استدعاؤه داخلياً من SDK. يسترجع معلمات أقرب Geozone والمسافة إليها. يسجل أيضاً موقع الجهاز لإشعارات الدفع الجغرافية (geo push notifications).

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

Request body parameters

Parameter	Type	Required	Description
application	string	نعم	Pushwoosh application code
hwid	string	نعم	Hardware device ID المستخدم في طلب /registerDevice.
lat	string	نعم	خط عرض الجهاز (Latitude).
lng	string	نعم	خط طول الجهاز (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	نعم	API access token من Pushwoosh Control Panel.
application	string	نعم	Pushwoosh application code
geozones	array	نعم	معلمات Geozone كمصفوفة JSON.
geozones.name	string	نعم	اسم Geozone.
geozones.lat	string	نعم	خط عرض Geozone.
geozones.lng	string	نعم	خط طول Geozone.
geozones.cooldown	integer	نعم	فترة الصمت بعد إرسال إشعار (بالثواني).
geozones.range	integer	نعم	نطاق Geozone (بالأمتار، من 50 إلى 1000).
geozones.content	string or object	مطلوب إذا كان presetCode فارغاً.	محتوى رسالة Geozone.
geozones.presetCode	string	مطلوب إذا كان content فارغاً.	Push preset للاستخدام بدلاً من content.
geozones.cluster	string	لا	حدد null لإلغاء ربط Cluster بـ Geozone.
geozones.campaign	string	لا	حدد null لإلغاء ربط Campaign بـ Geozone. إذا تم حذفه، تظل قيمة Campaign دون تغيير. ملاحظة: له أولوية أعلى من Campaign في Preset.
geozones.timetable	object	لا	يحدد فترات الجدول الزمني (timetable intervals).

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.

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

Request body parameters

Parameter	Type	Required	Description
auth	string	نعم	API access token من Pushwoosh Control Panel.
geoZoneId	string	نعم	Geozone ID من طلب /addGeoZone.
name	string	لا	اسم Geozone الجديد.
cooldown	integer	لا	فترة التهدئة (Cooldown) للتحديث، بالثواني.
status	integer	لا	0 - غير مفعل، 1 - مفعل.
content	string	لا	محتوى إشعار الدفع لـ Geozone. لا يمكن استخدامه مع presetCode.
cluster	string	لا	اسم Cluster الجديد. حدد null لإلغاء ربط Cluster بـ Geozone.
campaign	string	لا	معرف Campaign الجديد. حدد null لإلغاء ربط Campaign بـ Geozone. إذا تم حذفه، لن تتغير قيمة Campaign. له أولوية أعلى من Campaign من Preset.
lat	number	لا	خط عرض Geozone.
lng	number	لا	خط طول Geozone.
range	integer	لا	النطاق الجديد بالأمتار.
timetable	object	لا	الجدول الزمني لـ Geozone. انظر المزيد من المعلومات أدناه.

---

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	نعم	API access token من Pushwoosh Control Panel.
application	string	نعم	Pushwoosh application code
geozones	string	نعم	مصفوفة من المعرفات أو معرف واحد لـ Geozone المراد إزالته.

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	نعم	API access token من Pushwoosh Control Panel.
application	string	نعم	Pushwoosh application code
name	string	نعم	اسم Cluster.
cooldown	integer	نعم	تأخير قبل أن يتمكن مستخدم واحد من تلقي نفس الرسالة من Geozone Cluster، بالثواني.

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	نعم	API access token من Pushwoosh Control Panel.
application	string	نعم	Pushwoosh application code
geoZoneCluster	string	نعم	معرف Geozone cluster المراد إزالته.

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	نعم	API access token من Pushwoosh Control Panel.
application	string	نعم	Pushwoosh application code

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	نعم	API access token من Pushwoosh Control Panel.
application	string	نعم	Pushwoosh application code

Request example

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