onesignal-sdk 1.0.0

A Python wrapper around the OneSignal API

A Python client library for OneSignal API.

Table of Contents

• Installation

• Usage

  • Creating a service client

  • Creating a notification

  • Sending push notification

  • Cancelling a notification

  • Viewing push notifications

  • Viewing a push notification

  • Viewing apps

  • Creating an app

  • Updating an app

  • Viewing devices

  • Adding a device

  • Editing a device

  • CSV Export

  • Opening track

Installation

pip install onesignal_sdk

Usage

import onesignal as onesignal_sdk

Creating a client

You can create a OneSignal Client as shown below. You can find your user_auth_key and REST API Key (app_auth_key) on OneSignal Account & API Keys page.

onesignal_client = onesignal_sdk.Client(user_auth_key="XXXXX",
                                    app_auth_key="XXXX",
                                    app_id="APPID")

You can always create a Client with no credential and set them later:

onesignal_client = onesignal_sdk.Client()
onesignal_client.user_auth_key = "XXXXX"
onesignal_client.app_auth_key = "XXXXX"
onesignal_client.app_id = "APPID"

Creating a notification

new_notification = onesignal_sdk.Notification(post_body={"contents": {"en": "Message", "tr": "Mesaj"}})

if you want to change contents later:

new_notification = onesignal_sdk.Notification(post_body={"contents": {"en": "Message", "tr": "Mesaj"}})
...
...
new_notification.post_body["content"] = {"en": "New message"}

You can set filters, data, buttons and all of the fields available on OneSignal Documentation by updating post_body of notification:

new_notification.post_body["data"] = {"foo": 123, "bar": "foo"}
new_notification.post_body["headings"] = {"en": "English Title"}
new_notification.post_body["included_segments"] = ["Active Users", "Inactive Users"]
new_notification.post_body["filters"] = [
    {"field": "tag", "key": "level", "relation": "=", "value": "10"},
    {"operator": "OR"}, {"field": "tag", "key": "level", "relation": "=", "value": "20"}
]

Sending push notification

To can send a notification to Segments:

# create a onesignal client
onesignal_client = onesignal_sdk.Client(app_auth_key="XXXX", app_id="APPID")

# create a notification
new_notification = onesignal_sdk.Notification(post_body={
    "contents": {"en": "Message", "tr": "Mesaj"},
    "included_segments": ["Active Users"],
    "filters": [{"field": "tag", "key": "level", "relation": "=", "value": "10"}]
})

# send notification, it will return a response
onesignal_response = onesignal_client.send_notification(new_notification)
print(onesignal_response.status_code)
print(onesignal_response.json())

To send a notification to specific devices:

onesignal_client = onesignal_sdk.Client(app_auth_key="XXXX", app_id="APPID")
new_notification = onesignal_sdk.Notification(post_body={
    "contents": {"en": "Message"},
    "include_player_ids": ["id1", "id2"],
})

# send notification, it will return a response
onesignal_response = onesignal_client.send_notification(new_notification)
print(onesignal_response.status_code)
print(onesignal_response.json())

Cancelling a notification

onesignal_client = onesignal_sdk.Client(user_auth_key="XXXXX",
                                    app_auth_key="XXXX",
                                    app_id="APPID")

onesignal_response = onesignal_client.cancel_notification("notification_id")
print(onesignal_response.status_code)
print(onesignal_response.json())

Viewing push notifications

onesignal_response = onesignal_client.view_notifications(query={"limit": 30, "offset": 0})
if onesignal_response.status_code == 200:
    print(onesignal_response.json())

Viewing a push notification

onesignal_response = onesignal_client.view_notification("notification_id")
if onesignal_response.status_code == 200:
    print(onesignal_response.json())

Viewing apps

onesignal_response = onesignal_client.view_apps()

You can also view a single app:

onesignal_response = onesignal_client.view_app("app_id")

Creating an app

onesignal_client = onesignal_sdk.Client(user_auth_key="XXXXX",
                                    app_auth_key="XXXX",
                                    app_id="APPID")

app_body = {
    "name": "Test App",
    "apns_env": "production"
}

onesignal_response = onesignal_client.create_app(app_body)
if onesignal_response.status_code == 200:
    print(onesignal_response.json())

Updating an app

onesignal_client = onesignal_sdk.Client(user_auth_key="XXXXX",
                                    app_auth_key="XXXX",
                                    app_id="APPID")

app_body = {
    "name": "New App",
    "gcm_key": "XX-XXX-XXXXX"
}

onesignal_response = onesignal_client.update_app(app_id="XXXX", app_body=app_body)
if onesignal_response.status_code == 200:
    print(onesignal_response.json())

Viewing devices

onesignal_response = onesignal_client.view_devices(query={"limit": 20})
if onesignal_response.status_code == 200:
    print(onesignal_response.json())

You can also view a device:

onesignal_response = onesignal_client.view_device("device_id")

Adding a device

onesignal_client = onesignal_sdk.Client(user_auth_key="XXXXX",
                                    app_auth_key="XXXX",
                                    app_id="APPID")

device_body = {
    "device_type": 1,
    "language": "tr"
}

onesignal_response = onesignal_client.create_device(device_body=device_body)

Editing a device

onesignal_client = onesignal_sdk.Client(user_auth_key="XXXXX",
                                    app_auth_key="XXXX",
                                    app_id="APPID")

device_body = {
    "device_type": 1,
    "language": "en"
}

onesignal_response = onesignal_client.update_device(device_id="device_id", device_body=device_body)

CSV Export

onesignal_response = onesignal_client.csv_export(post_body={"extra_fields": ["location"]})
if onesignal_response.status_code == 200:
    print(onesignal_response.json())

Opening track

onesignal_response = onesignal_client.track_open("notification_id", track_body={"opened": True})

Licence

This project is under the MIT license.