/EventDetectionAPI-SDK-python

The Telstra Event Detection API provides the ability to subscribe to and receive network events for a given set of mobile numbers

Primary LanguagePythonApache License 2.0Apache-2.0

Telstra_EventDetection

  • API version: 1.0.0
  • Package version: 1.0.0

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

pip install git+https://github.com/Telstra/EventDetectionAPI-SDK-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Telstra/EventDetectionAPI-SDK-python.git)

import Telstra_EventDetection

Setuptools

Install via Setuptools.

python setup.py install --user
import Telstra_EventDetection

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import Telstra_EventDetection
from Telstra_EventDetection.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = Telstra_EventDetection.AuthenticationApi()
client_id = 'client_id_example' # str | 
client_secret = 'client_secret_example' # str | 
grant_type = 'client_credentials' # str |  (default to client_credentials)

try:
    # Generate authentication token
    api_response = api_instance.auth_token(client_id, client_secret, grant_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->auth_token: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://tapi.telstra.com

Class Method HTTP request Description
AuthenticationApi auth_token POST /v2/oauth/token Generate authentication token
GetSubscriptionApi get_subscription POST /v1/eventdetection/events/subscriptions Get Event Subscriptions
LongPollApi longpoll POST /v1/eventdetection/events/{eventType} Poll events
PushNotificationsApi push_notifications POST /v1/eventdetection/events/notifications Push event notifications
RegistrationApi register POST /v1/eventdetection/events Register
RegistrationApi unregister DELETE /v1/eventdetection/events/{eventType} Unregister

Documentation For Models

Documentation For Authorisation

auth

  • Type: OAuth
  • Flow: application
  • Authorisation URL:
  • Scopes:
  • v1_eventdetection_simswap: v1_eventdetection_simswap

Author