{"status_code":200,"status_message":"OK","response": null}
Example{"request":{"application": "XXXXX-XXXXX", // Pushwoosh application code"push_token": "dec301908b9ba8df85e57a58e40f96f523f4c2068674f5fe2ba25cdc250a2a41","hwid": "1CA68A12-8DAC-4BB7-BEE5-B756288B6D3C", // hardware device ID"idfa" : "AEBE52E7-03EE-455A-B3C4-E57283966239", // optional"timezone": 3600, // offset in seconds"device_type": 1,"language": "en", // ISO 639-1|639-2 language code"userId": "Alex", // optional// system tags, optionals"app_version": "1.2.3","device_model": "Samsung SM-G355H","jailbroken": "1", // 1 or 0"os_version": "2.3",// optional encryption keys for chrome/firefox"public_key": "BNmDO4BTKEMJqaqprTf7t/HBUd2BQ/orc88cc/scS5CFP6zhQGIHI1/GgRQD8c4kTxTEEF0quvIUiLQqoBY0/Qo=","auth_token": "RlRmCCdGM/s7ouuhjKFzoQ==",//FCM keys, required for Chrome and Firefox (for XMPP)"fcm_token": "BNmDO4BTKEMJqaqprTf7t/HBUd2BQ/orc88cc/scS5CFP6zhQGIHI1/GgRQD8c4kTxTEEF0quvIUiLQqoBY0/Qo=","fcm_push_set": "RlRmCCdGM/s7ouuhjKFzoQ=="}}
Possible device types:
1 – iOS
2 – BB
3 – Android
5 – Windows Phone
7 – OS X
8 – Windows 8
9 – Amazon
10 – Safari
11 – Chrome
12 – Firefox
13 – IE11
17 – Huawei
For emails call /registerEmail
.
Status codes:
HTTP Status code | status_code | Description |
200 | 200 | Device successfully registered |
200 | 210 | Argument error. See status_message for more info. |
400 | N/A | Malformed request string |
500 | 500 | Internal error |
PHP<?php//see http://gomoob.github.io/php-pushwoosh/register-device.htmluse Gomoob\Pushwoosh\Model\Request\RegisterDeviceRequest;// creates request instance$request = RegisterDeviceRequest::create()->setDeviceType(DeviceType::1())->setHwid('HWID')->setLanguage('fr')->setPushToken('xxxxxxxx')->setTimezone(3600);// call '/registerDevice' Web Service$response = $pushwoosh->registerDevice($request);if($response->isOk()) {print 'Ok, operation successful.';} else {print 'Oups, the operation failed :-(';print 'Status code : ' . $response->getStatusCode();print 'Status message : ' . $response->getStatusMessage();}
{"status_code": 200,"status_message": "OK","response": null}
Example{"request":{"application": "XXXXX-XXXXX", // Pushwoosh application code"hwid": "8f65b16df378e7a6bece9614e1530fb2" // hardware device ID used in /registerDevice function call}}
For emails call /deleteEmail
.
Status codes:
HTTP Status code | status_code | Description |
200 | 200 | Device successfully unsubscribed |
200 | 210 | Argument error. See status_message for more info. |
400 | N/A | Malformed request string |
500 | 500 | Internal error |
PHP<?php// see http://gomoob.github.io/php-pushwoosh/unregister-device.htmluse Gomoob\Pushwoosh\Model\Request\UnregisterDeviceRequest;// creates request instance$request = UnregisterDeviceRequest::create()->setHwid('HWID');// call '/unregisterDevice' Web Service$response = $pushwoosh->unregisterDevice($request);if($response->isOk()) {print 'Ok, operation successful.';} else {print 'Oups, the operation failed :-(';print 'Status code : ' . $response->getStatusCode();print 'Status message : ' . $response->getStatusMessage();}
{"status_code": "200","status_message": "OK","response": {"exist" : true //or false"push_token_exist": true //or false}}
Example{"request": {"application": "XXXXX-XXXXX", // Pushwoosh application code"hwid": "hardware-device-id"}}
{"status_code":200,"status_message":"OK"}
Example{"request":{"application" : "XXXXX-XXXXX", // Pushwoosh application code"hwid": "8f65b16df378e7a6bece9614e1530fb2", // hardware device ID used in /registerDevice function call"badge": 4 // current badge on the application}}
Called from the SDK internally. Sends current badge value for a device to Pushwoosh. This happens internally when app changes badge value on iOS device. Allows auto-incrementing badges to work properly.
This method IS NOT used to update the badge value on the device. Instead please use /createMessage
request with the "ios_badges"
parameter.
PHP<?php//see http://gomoob.github.io/php-pushwoosh/set-badge.htmluse Gomoob\Pushwoosh\Model\Request\SetBadgeRequest;// Creates the request instance$request = RegisterDeviceRequest::create()->setBadge(5)->setHwid('HWID');// Call the '/setBadge' Web Service$response = $pushwoosh->setBadge($request);if($response->isOk()) {print 'Ok, operation successful.';} else {print 'Oups, the operation failed :-(';print 'Status code : ' . $response->getStatusCode();print 'Status message : ' . $response->getStatusMessage();}
{"status_code":200,"status_message":"OK"}
Example{"request":{"application" : "XXXXX-XXXXX", // Pushwoosh application code"hwid": "8f65b16df378e7a6bece9614e1530fb2" // hardware device ID used in /registerDevice function call}}
{"status_code": 200,"status_message": "OK","response": null}
Example{"request":{"application" : "XXXXX-XXXXX", // Pushwoosh application code"hwid": "8f65b16df378e7a6bece9614e1530fb2", // hardware device ID used in /registerDevice function call"userId": "USER012345", // the user id to associate with the push open event"hash": "HASH_TAG" // hash tag received in push notification (“p” parameter in the push payload)}}
PHP<?php//see http://gomoob.github.io/php-pushwoosh/push-stat.htmluse Gomoob\Pushwoosh\Model\Request\PushStatRequest;// Creates the request instance$request = PushStatRequest::create()->setHash('hash')->setHwid('HWID');// Call the '/pushStat' Web Service$response = $pushwoosh->pushStat($request);if($response->isOk()) {print 'Ok, operation successful.';} else {print 'Oups, the operation failed :-(';print 'Status code : ' . $response->getStatusCode();print 'Status message : ' . $response->getStatusMessage();}
{"status_code": 200,"status_message": "OK","response": null}
Example{"request":{"application" : "XXXXX-XXXXX", // Pushwoosh application code"hwid": "8f65b16df378e7a6bece9614e1530fb2", // hardware device ID used in /registerDevice function call"hash": "HASH_TAG" // hash tag received in push notification (“p” parameter in the push payload)}}
{"status_code":200,"status_message":"OK","response": null}
Example{"request":{"transactionDate": "2014-10-30T10:55:14Z", // date of the transaction"application": "XXXXX-XXXXX", // Pushwoosh application code"hwid": "F6BA94A2-6BB2-XXXX-XXXX-E945C686240D", // hardware device ID used in /registerDevice function call"quantity": 1, // items quantity"currency": "USD", // transaction currency"productIdentifier": "com.pushon.purchase.1", // product SKU"price": 0.99 // item price}}
{"status_code": "200","status_message": "OK","response": null}
Example{"request": {"application":"XXXXX-XXXXX", // Pushwoosh app code"hwid": "hardware-device-id"}}