ข้ามไปยังเนื้อหา

Geozones API

getNearestZone

Anchor link to

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

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

พารามิเตอร์ของคำขอ

Anchor link to
พารามิเตอร์ประเภท
จำเป็นคำอธิบาย
applicationstringใช่รหัสแอปพลิเคชัน Pushwoosh
hwidstringใช่ID อุปกรณ์ฮาร์ดแวร์ ที่ใช้ในคำขอ /registerDevice
latstringใช่ละติจูดของอุปกรณ์
lngstringใช่ลองจิจูดของอุปกรณ์

ตัวอย่างคำขอ

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

ตัวอย่าง PHP

Anchor link to
// ดูรายละเอียดที่ http://gomoob.github.io/php-pushwoosh/get-nearest-zone.html
use Gomoob\Pushwoosh\Model\Request\GetNearestZoneRequest;
// สร้างอินสแตนซ์ของคำขอ
$request = GetNearestZoneRequest::create()
->setHwid('HWID')
->setLat(10.12345)
->setLng(28.12345);
// เรียกใช้ Web Service '/getNearestZone'
$response = $pushwoosh->getNearestZone($request);
if ($response->isOk()) {
print 'ชื่อโซน : ' . $response->getResponse()->getName();
print 'ละติจูด : ' . $response->getResponse()->getLat();
print 'ลองจิจูด : ' . $response->getResponse()->getLng();
print 'ระยะ : ' . $response->getResponse()->getRange();
print 'ระยะทาง : ' . $response->getResponse()->getDistance();
} else {
print 'อุ๊ปส์ การดำเนินการล้มเหลว :-(';
print 'รหัสสถานะ : ' . $response->getStatusCode();
print 'ข้อความสถานะ : ' . $response->getStatusMessage();
}

addGeoZone

Anchor link to

เพิ่ม Geozone ไปยังแอปที่ระบุ

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

พารามิเตอร์ของคำขอ

Anchor link to
พารามิเตอร์
ประเภท
จำเป็นคำอธิบาย
authstringใช่โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
applicationstringใช่รหัสแอปพลิเคชัน Pushwoosh
geozonesarrayใช่พารามิเตอร์ของ Geozone ในรูปแบบอาร์เรย์ JSON
geozones.namestringใช่ชื่อ Geozone
geozones.latstringใช่ละติจูดของ Geozone
geozones.lngstringใช่ลองจิจูดของ Geozone
geozones.cooldownintegerใช่ช่วงเวลาเงียบหลังจากการส่งการแจ้งเตือน (เป็นวินาที)
geozones.rangeintegerใช่ระยะของ Geozone (เป็นเมตร ตั้งแต่ 50 ถึง 1000)
geozones.contentstring or objectจำเป็นหาก presetCode ว่างเปล่าเนื้อหาข้อความของ Geozone
geozones.presetCodestringจำเป็นหาก content ว่างเปล่าPush preset ที่จะใช้แทน content
geozones.clusterstringไม่ระบุ null เพื่อยกเลิกการผูกคลัสเตอร์จาก Geozone
geozones.campaignstringไม่ระบุ null เพื่อยกเลิกการผูกแคมเปญจาก Geozone หากไม่ระบุ ค่าแคมเปญจะยังคงไม่เปลี่ยนแปลง หมายเหตุ: มีลำดับความสำคัญสูงกว่าแคมเปญใน preset
geozones.timetableobjectไม่ตั้งค่าช่วงเวลาตามตารางเวลา

ตัวอย่างคำขอ

Anchor link to
{
"request": {
"auth": "yxoPUlwqm............pIyEX4H", // โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
"application": "XXXXX-XXXXX", // รหัสแอปพลิเคชัน Pushwoosh
"geozones": [{
"name": "Statue of George", // จำเป็น. ชื่อ Geozone
"lat": "40.70087797", // จำเป็น. ละติจูดของ Geozone
"lng": "-73.931851387", // จำเป็น. ลองจิจูดของ Geozone
"cooldown": 60, // เป็นวินาที, จำเป็น. ช่วงเวลาเงียบหลังจากการส่งการแจ้งเตือน
"range": 50, // เป็นเมตร, ตั้งแต่ 50 ถึง 1000, จำเป็น. ระยะของ geozone
"content": "Lorem ipsum dolor sit amet,
consectetur adipiscing elit.", // หรืออ็อบเจกต์
"presetCode": "AAAAA-BBBBB", // ไม่จำเป็น. สามารถใช้ Push preset แทน content ได้
"cluster": "GEOZONE CLUSTER CODE", // ไม่จำเป็น. จะใช้ช่วงเวลา cooldown ของคลัสเตอร์
"campaign": "CAMPAIGN_CODE", // ไม่จำเป็น. ระบุ null เพื่อยกเลิกการผูกแคมเปญจาก Geozone
"timetable": { // ไม่จำเป็น
"timezone": 1234, // เป็นวินาที
"Mon": [ // วันที่ใช้ได้: Mon, Tue, Wed, Thu, Fri, Sat, Sun. การส่งพุช
{
"start": "04:11",
"stop": "12:00"
}
],
"Sun": [
{ // หนึ่งหรือสองช่วงเวลา
"start": "01:11",
"stop": "17:00"
},
{
"start": "18:01",
"stop": "23:59"
}
]
}
}]
}
}

updateGeoZone

Anchor link to

อัปเดตคุณสมบัติของ Geozone

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

พารามิเตอร์ของคำขอ

Anchor link to
พารามิเตอร์
ประเภท
จำเป็นคำอธิบาย
authstringใช่โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
geoZoneIdstringใช่ID ของ Geozone จากคำขอ /addGeoZone
namestringไม่ชื่อ Geozone ใหม่
cooldownintegerไม่Cooldown ที่จะอัปเดต เป็นวินาที
statusintegerไม่0 - ปิดใช้งาน, 1 - เปิดใช้งาน
contentstringไม่เนื้อหาสำหรับการแจ้งเตือนพุชของ Geozone ไม่สามารถใช้ร่วมกับ presetCode ได้
clusterstringไม่ชื่อคลัสเตอร์ใหม่ ระบุ null เพื่อยกเลิกการผูกคลัสเตอร์จาก Geozone
campaignstringไม่ID แคมเปญใหม่ ระบุ null เพื่อยกเลิกการผูกแคมเปญจาก Geozone หากไม่ระบุ ค่าแคมเปญจะไม่เปลี่ยนแปลง มีลำดับความสำคัญสูงกว่าแคมเปญจาก preset
latnumberไม่ละติจูดของ Geozone
lngnumberไม่ลองจิจูดของ Geozone
rangeintegerไม่ระยะใหม่เป็นเมตร
timetableobjectไม่ตารางเวลาของ Geozone ดูข้อมูลเพิ่มเติมด้านล่าง

ตัวอย่างคำขอ

Anchor link to
{
"request": {
"auth": "yxoPUlwqm............pIyEX4H", // จำเป็น, โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
"geoZoneId": 100016750, // จำเป็น, จากเมธอด /addGeoZone
"name": "new geozone name", // ไม่จำเป็น
"cooldown": 222, // เป็นวินาที, ไม่จำเป็น
"status": 0, // ไม่จำเป็น, 0 - ปิดใช้งาน, 1 - เปิดใช้งาน
"presetCode": "BBBBB-AAAAA", // ไม่จำเป็น, ไม่สามารถใช้ร่วมกับ "content" ได้
"content": "new geozone content", // ไม่จำเป็น, ไม่สามารถใช้ร่วมกับ "presetCode" ได้
"cluster": "GEOZONE CLUSTER CODE", // ไม่จำเป็น. ระบุ null เพื่อยกเลิกการผูกคลัสเตอร์จาก Geozone
"campaign": "CAMPAIGN_CODE", // ไม่จำเป็น. ระบุ null เพื่อยกเลิกการผูกแคมเปญจาก Geozone
"lat": 10.56, // ไม่จำเป็น, ละติจูดของ geozone
"lng": 12.523, // ไม่จำเป็น, ลองจิจูดของ geozone
"range": 500, // ไม่จำเป็น, ระยะของ geozone
"timetable": { // ไม่จำเป็น
"timezone": 1234, // เป็นวินาที
"Mon": [ // วันที่ใช้ได้: Mon, Tue, Wed, Thu, Fri, Sat, Sun. การส่งพุช
{
"start": "04:11",
"stop": "12:00"
}
],
"Sun": [
{ // หนึ่งหรือสองช่วงเวลา
"start": "01:11",
"stop": "17:00"
},
{
"start": "18:01",
"stop": "23:59"
}
]
}
}
}

deleteGeoZone

Anchor link to

ลบ Geozones ออกจากแอป

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

พารามิเตอร์ของคำขอ

Anchor link to
พารามิเตอร์
ประเภท
จำเป็นคำอธิบาย
authstringใช่โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
applicationstringใช่รหัสแอปพลิเคชัน Pushwoosh
geozonesstringใช่อาร์เรย์ของ ID หรือ ID เดียวของ Geozone ที่จะลบ

ตัวอย่างคำขอ

Anchor link to
{
"request": {
"auth": "yxoPUlwqm............pIyEX4H", // จำเป็น, โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
"application": "XXXXX-XXXXX", // จำเป็น, รหัสแอปพลิเคชัน Pushwoosh
"geozones": [550, 526] // จำเป็น, ID ของ geozones
}
}

addGeoZoneCluster

Anchor link to

เพิ่ม Geozone Cluster ไปยังแอป

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

พารามิเตอร์ของคำขอ

Anchor link to
พารามิเตอร์
ประเภท
จำเป็นคำอธิบาย
authstringใช่โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
applicationstringใช่รหัสแอปพลิเคชัน Pushwoosh
namestringใช่ชื่อคลัสเตอร์
cooldownintegerใช่ความล่าช้าก่อนที่ผู้ใช้คนเดียวจะสามารถรับข้อความเดียวกันจาก Geozone Cluster ได้อีกครั้ง เป็นวินาที

ตัวอย่างคำขอ

Anchor link to
{
"request": {
"auth": "yxoPUlwqm............pIyEX4H", // จำเป็น, โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
"application": "XXXXX-XXXXX", // จำเป็น, รหัสแอปพลิเคชัน Pushwoosh
"name": "Raccoon city", // จำเป็น, ชื่อคลัสเตอร์
"cooldown": 3210 // จำเป็น, เป็นวินาที
}
}

deleteGeoZoneCluster

Anchor link to

ลบ Geozone Cluster ออกจากแอป

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

พารามิเตอร์ของคำขอ

Anchor link to
พารามิเตอร์
ประเภท
จำเป็นคำอธิบาย
authstringใช่โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
applicationstringใช่รหัสแอปพลิเคชัน Pushwoosh
geoZoneClusterstringใช่ID ของ Geozone cluster ที่จะลบ

ตัวอย่างคำขอ

Anchor link to
{
"request": {
"auth": "yxoPUlwqm............pIyEX4H", // จำเป็น, โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
"application": "XXXXX-XXXXX", // จำเป็น, รหัสแอปพลิเคชัน Pushwoosh
"geoZoneCluster": "EA1CE-69405" // จำเป็น, ID ของคลัสเตอร์ที่ได้รับจากคำขอ /addGeoZoneCluster
}
}

listGeoZones

Anchor link to

ดึงรายการ Geozones สำหรับแอป

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

พารามิเตอร์ของคำขอ

Anchor link to
พารามิเตอร์
ประเภท
จำเป็นคำอธิบาย
authstringใช่โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
applicationstringใช่รหัสแอปพลิเคชัน Pushwoosh

ตัวอย่างคำขอ

Anchor link to
{
"request": {
"auth": "yxoPUlwqm............pIyEX4H", // จำเป็น, โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
"application": "XXXXX-XXXXX" // จำเป็น, รหัสแอปพลิเคชัน Pushwoosh
}
}

listGeoZoneClusters

Anchor link to

ดึงรายการคลัสเตอร์ Geozone สำหรับแอป

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

พารามิเตอร์ของคำขอ

Anchor link to
พารามิเตอร์
ประเภท
จำเป็นคำอธิบาย
authstringใช่โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
applicationstringใช่รหัสแอปพลิเคชัน Pushwoosh

ตัวอย่างคำขอ

Anchor link to
{
"request": {
"auth": "yxoPUlwqm............pIyEX4H", // จำเป็น, โทเค็นการเข้าถึง API จากแผงควบคุม Pushwoosh
"application": "XXXXX-XXXXX" // จำเป็น, รหัสแอปพลิเคชัน Pushwoosh
}
}