Geozones API

getNearestZone

เรียกใช้ภายในจาก SDK ดึงพารามิเตอร์ของ geozone ที่ใกล้ที่สุดและระยะทางไปยังจุดนั้น นอกจากนี้ยังบันทึกตำแหน่งอุปกรณ์สำหรับการแจ้งเตือนแบบ geo push

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

Request body parameters

Parameter	Type	Required	Description
application	`string`	Yes	รหัสแอปพลิเคชัน Pushwoosh
hwid	`string`	Yes	Hardware device ID ที่ใช้ใน request `/registerDevice`
lat	`string`	Yes	ละติจูดของอุปกรณ์
lng	`string`	Yes	ลองจิจูดของอุปกรณ์

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	API access token จาก Pushwoosh Control Panel
application	`string`	Yes	รหัสแอปพลิเคชัน Pushwoosh
geozones	`array`	Yes	พารามิเตอร์ Geozone ในรูปแบบ JSON array
geozones.name	`string`	Yes	ชื่อ Geozone
geozones.lat	`string`	Yes	ละติจูด Geozone
geozones.lng	`string`	Yes	ลองจิจูด Geozone
geozones.cooldown	`integer`	Yes	ช่วงเวลาเงียบหลังจากส่งการแจ้งเตือน (เป็นวินาที)
geozones.range	`integer`	Yes	ระยะ Geozone (เป็นเมตร ตั้งแต่ 50 ถึง 1000)
geozones.content	`string or object`	Required if `presetCode` is empty.	เนื้อหาข้อความ Geozone
geozones.presetCode	`string`	Required if `content` is empty.	Push preset ที่จะใช้แทน `content`
geozones.cluster	`string`	No	ระบุ `null` เพื่อยกเลิกการผูก cluster จาก Geozone
geozones.campaign	`string`	No	ระบุ `null` เพื่อยกเลิกการผูก campaign จาก Geozone หากละเว้น ค่า campaign จะไม่เปลี่ยนแปลง หมายเหตุ: มีความสำคัญสูงกว่า campaign ใน preset
geozones.timetable	`object`	No	ตั้งค่าช่วงเวลาตารางเวลา

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`	Yes	API access token จาก Pushwoosh Control Panel
geoZoneId	`string`	Yes	Geozone ID จาก request `/addGeoZone`
name	`string`	No	ชื่อ Geozone ใหม่
cooldown	`integer`	No	Cooldown ที่จะอัปเดต เป็นวินาที
status	`integer`	No	0 - ปิดใช้งาน, 1 - เปิดใช้งาน
content	`string`	No	เนื้อหาสำหรับการแจ้งเตือนแบบ push ของ Geozone ไม่สามารถใช้ร่วมกับ `presetCode` ได้
cluster	`string`	No	ชื่อ cluster ใหม่ ระบุ `null` เพื่อยกเลิกการผูก cluster จาก Geozone
campaign	`string`	No	Campaign ID ใหม่ ระบุ `null` เพื่อยกเลิกการผูก Campaign จาก Geozone หากละเว้น ค่า Campaign จะไม่เปลี่ยนแปลง มีความสำคัญสูงกว่า Campaign จาก preset
lat	`number`	No	ละติจูด Geozone
lng	`number`	No	ลองจิจูด Geozone
range	`integer`	No	ระยะใหม่เป็นเมตร
timetable	`object`	No	ตารางเวลา 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`	Yes	API access token จาก Pushwoosh Control Panel
application	`string`	Yes	รหัสแอปพลิเคชัน Pushwoosh
geozones	`string`	Yes	Array ของ ID หรือ ID เดียว ของ 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`	Yes	API access token จาก Pushwoosh Control Panel
application	`string`	Yes	รหัสแอปพลิเคชัน Pushwoosh
name	`string`	Yes	ชื่อ Cluster
cooldown	`integer`	Yes	ความล่าช้าก่อนที่ผู้ใช้คนเดียวจะได้รับข้อความเดียวกันจาก 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`	Yes	API access token จาก Pushwoosh Control Panel
application	`string`	Yes	รหัสแอปพลิเคชัน Pushwoosh
geoZoneCluster	`string`	Yes	ID ของ 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`	Yes	API access token จาก Pushwoosh Control Panel
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	API access token จาก Pushwoosh Control Panel
application	`string`	Yes	รหัสแอปพลิเคชัน Pushwoosh

Request example

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