Geozones API

getNearestZone

SDK থেকে অভ্যন্তরীণভাবে কল করা হয়। নিকটতম জিওজোনের প্যারামিটার এবং এর দূরত্ব পুনরুদ্ধার করে। এছাড়াও জিও পুশ নোটিফিকেশনের জন্য ডিভাইসের অবস্থান রেকর্ড করে।

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

Request body parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
application	string	হ্যাঁ	Pushwoosh অ্যাপ্লিকেশন কোড
hwid	string	হ্যাঁ	/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

একটি নির্দিষ্ট অ্যাপে একটি জিওজোন যোগ করে।

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

Request body parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
auth	string	হ্যাঁ	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
application	string	হ্যাঁ	Pushwoosh অ্যাপ্লিকেশন কোড
geozones	array	হ্যাঁ	JSON অ্যারে হিসেবে জিওজোন প্যারামিটার।
geozones.name	string	হ্যাঁ	জিওজোনের নাম।
geozones.lat	string	হ্যাঁ	জিওজোনের অক্ষাংশ।
geozones.lng	string	হ্যাঁ	জিওজোনের দ্রাঘিমাংশ।
geozones.cooldown	integer	হ্যাঁ	নোটিফিকেশন পাঠানোর পরে সাইলেন্ট পিরিয়ড বা বিরতি (সেকেন্ডে)।
geozones.range	integer	হ্যাঁ	জিওজোনের রেঞ্জ (মিটারে, ৫০ থেকে ১০০০ পর্যন্ত)।
geozones.content	string or object	আবশ্যক যদি presetCode খালি থাকে।	জিওজোন মেসেজের কন্টেন্ট।
geozones.presetCode	string	আবশ্যক যদি content খালি থাকে।	content-এর পরিবর্তে ব্যবহার করার জন্য পুশ প্রিসেট।
geozones.cluster	string	না	জিওজোন থেকে একটি ক্লাস্টার আনবাইন্ড (unbind) করতে null উল্লেখ করুন।
geozones.campaign	string	না	জিওজোন থেকে একটি ক্যাম্পেইন আনবাইন্ড করতে null উল্লেখ করুন। বাদ দিলে, ক্যাম্পেইনের মান অপরিবর্তিত থাকে। নোট: প্রিসেটের ক্যাম্পেইনের চেয়ে এর অগ্রাধিকার বেশি।
geozones.timetable	object	না	টাইমটেবিল বা সময়সূচীর বিরতি সেট করে।

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

জিওজোনের প্রপার্টি আপডেট করে।

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

Request body parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
auth	string	হ্যাঁ	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
geoZoneId	string	হ্যাঁ	/addGeoZone রিকোয়েস্ট থেকে প্রাপ্ত জিওজোন আইডি।
name	string	না	নতুন জিওজোনের নাম।
cooldown	integer	না	আপডেট করার জন্য কুলডাউন, সেকেন্ডে।
status	integer	না	0 - নিষ্ক্রিয় (deactivated), 1 - সক্রিয় (activated)।
content	string	না	জিওজোন পুশ নোটিফিকেশনের জন্য কন্টেন্ট। presetCode-এর সাথে ব্যবহার করা যাবে না।
cluster	string	না	নতুন ক্লাস্টারের নাম। জিওজোন থেকে ক্লাস্টার আনবাইন্ড করতে null উল্লেখ করুন।
campaign	string	না	নতুন ক্যাম্পেইন আইডি। জিওজোন থেকে ক্যাম্পেইন আনবাইন্ড করতে null উল্লেখ করুন। বাদ দিলে, ক্যাম্পেইনের মান পরিবর্তন হবে না। প্রিসেটের ক্যাম্পেইনের চেয়ে এর অগ্রাধিকার বেশি।
lat	number	না	জিওজোনের অক্ষাংশ।
lng	number	না	জিওজোনের দ্রাঘিমাংশ।
range	integer	না	মিটারে নতুন রেঞ্জ।
timetable	object	না	জিওজোন টাইমটেবিল। নিচে আরও তথ্য দেখুন।

---

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

অ্যাপ থেকে জিওজোনগুলো সরিয়ে দেয়।

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

Request body parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
auth	string	হ্যাঁ	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
application	string	হ্যাঁ	Pushwoosh অ্যাপ্লিকেশন কোড
geozones	string	হ্যাঁ	আইডিগুলোর অ্যারে বা সরানোর জন্য একটি জিওজোনের একক আইডি।

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

অ্যাপে জিওজোন ক্লাস্টার যোগ করে।

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

Request body parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
auth	string	হ্যাঁ	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
application	string	হ্যাঁ	Pushwoosh অ্যাপ্লিকেশন কোড
name	string	হ্যাঁ	ক্লাস্টারের নাম।
cooldown	integer	হ্যাঁ	জিওজোন ক্লাস্টার থেকে একই মেসেজ একজন ব্যবহারকারী পুনরায় পাওয়ার আগে বিলম্ব, সেকেন্ডে।

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

অ্যাপ থেকে একটি জিওজোন ক্লাস্টার সরিয়ে দেয়।

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

Request body parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
auth	string	হ্যাঁ	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
application	string	হ্যাঁ	Pushwoosh অ্যাপ্লিকেশন কোড
geoZoneCluster	string	হ্যাঁ	সরানোর জন্য জিওজোন ক্লাস্টারের আইডি।

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

অ্যাপের জন্য জিওজোনগুলোর একটি তালিকা পুনরুদ্ধার করে।

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

Request body parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
auth	string	হ্যাঁ	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
application	string	হ্যাঁ	Pushwoosh অ্যাপ্লিকেশন কোড

Request example

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

listGeoZoneClusters

অ্যাপের জন্য জিওজোন ক্লাস্টারগুলোর একটি তালিকা পুনরুদ্ধার করে।

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

Request body parameters

প্যারামিটার	টাইপ	প্রয়োজনীয়	বিবরণ
auth	string	হ্যাঁ	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
application	string	হ্যাঁ	Pushwoosh অ্যাপ্লিকেশন কোড

Request example

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