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 Application code
hwid	`string`	Yes	在 `/registerDevice` 请求中使用的 Hardware device ID。
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	来自 Pushwoosh Control Panel 的 API access token。
application	`string`	Yes	Pushwoosh Application code
geozones	`array`	Yes	作为 JSON 数组的 Geozone 参数。
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.	用于替代 `content` 的 Push preset。
geozones.cluster	`string`	No	指定 `null` 以从 Geozone 解绑 Cluster。
geozones.campaign	`string`	No	指定 `null` 以从 Geozone 解绑 Campaign。如果省略，Campaign 值保持不变。注意：优先级高于预设中的 Campaign。
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	来自 Pushwoosh Control Panel 的 API access token。
geoZoneId	`string`	Yes	来自 `/addGeoZone` 请求的 Geozone ID。
name	`string`	No	新的 Geozone 名称。
cooldown	`integer`	No	要更新的冷却时间（以秒为单位）。
status	`integer`	No	0 - 停用，1 - 激活。
content	`string`	No	Geozone 推送通知的内容。不能与 `presetCode` 一起使用。
cluster	`string`	No	新的 Cluster 名称。指定 `null` 以从 Geozone 解绑 Cluster。
campaign	`string`	No	新的 Campaign ID。指定 `null` 以从 Geozone 解绑 Campaign。如果省略，Campaign 值将不会改变。优先级高于预设中的 Campaign。
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	来自 Pushwoosh Control Panel 的 API access token。
application	`string`	Yes	Pushwoosh Application code
geozones	`string`	Yes	要移除的 Geozone 的 ID 数组或单个 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 Control Panel 的 API access token。
application	`string`	Yes	Pushwoosh Application code
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	来自 Pushwoosh Control Panel 的 API access token。
application	`string`	Yes	Pushwoosh Application code
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 Control Panel 的 API access token。
application	`string`	Yes	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`	Yes	来自 Pushwoosh Control Panel 的 API access token。
application	`string`	Yes	Pushwoosh Application code

Request example

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