| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
Python >=3.6
pip install onesignal-python-apiYou can also install directly from GitHub using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.gitYou may need to run pip with root permission:
sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.gitInstall via Setuptools.
python setup.py install --userTo install the package for all users:
sudo python setup.py installPlease follow the installation procedure and then run the following:
import onesignal
from onesignal.api import default_api
# See configuration.py for a list of all supported configuration parameters.
# Some of the OneSignal endpoints require USER_KEY bearer token for authorization as long as others require APP_KEY
# (also knows as REST_API_KEY). We recommend adding both of them in the configuration page so that you will not need
# to figure it yourself.
configuration = onesignal.Configuration(
app_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints
user_key = "YOUR_ORGANIZATION_API_KEY" # Organization key is only required for creating new apps and other top-level endpoints
)
# Enter a context with an instance of the API client
with onesignal.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = default_api.DefaultApi(api_client)All URIs are relative to https://api.onesignal.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | cancel_notification | DELETE /notifications/{notification_id} | Stop a scheduled or currently outgoing notification |
| DefaultApi | create_alias | PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | |
| DefaultApi | create_alias_by_subscription | PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity | |
| DefaultApi | create_app | POST /apps | Create an app |
| DefaultApi | create_notification | POST /notifications | Create notification |
| DefaultApi | create_segment | POST /apps/{app_id}/segments | Create Segment |
| DefaultApi | create_subscription | POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions | |
| DefaultApi | create_user | POST /apps/{app_id}/users | |
| DefaultApi | delete_alias | DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} | |
| DefaultApi | delete_segment | DELETE /apps/{app_id}/segments/{segment_id} | Delete Segment |
| DefaultApi | delete_subscription | DELETE /apps/{app_id}/subscriptions/{subscription_id} | |
| DefaultApi | delete_user | DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id} | |
| DefaultApi | export_events | POST /notifications/{notification_id}/export_events?app_id={app_id} | Export CSV of Events |
| DefaultApi | export_subscriptions | POST /players/csv_export?app_id={app_id} | Export CSV of Subscriptions |
| DefaultApi | get_aliases | GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity | |
| DefaultApi | get_aliases_by_subscription | GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity | |
| DefaultApi | get_app | GET /apps/{app_id} | View an app |
| DefaultApi | get_apps | GET /apps | View apps |
| DefaultApi | get_notification | GET /notifications/{notification_id} | View notification |
| DefaultApi | get_notification_history | POST /notifications/{notification_id}/history | Notification History |
| DefaultApi | get_notifications | GET /notifications | View notifications |
| DefaultApi | get_outcomes | GET /apps/{app_id}/outcomes | View Outcomes |
| DefaultApi | get_segments | GET /apps/{app_id}/segments | Get Segments |
| DefaultApi | get_user | GET /apps/{app_id}/users/by/{alias_label}/{alias_id} | |
| DefaultApi | transfer_subscription | PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner | |
| DefaultApi | unsubscribe_email_with_token | POST /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token |
| DefaultApi | update_app | PUT /apps/{app_id} | Update an app |
| DefaultApi | update_live_activity | POST /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push |
| DefaultApi | update_subscription | PATCH /apps/{app_id}/subscriptions/{subscription_id} | |
| DefaultApi | update_user | PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id} |
| Back | FazBrowse Home | New Git URL |