Skip to content

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

Notifications You must be signed in to change notification settings

telstra/EventDetectionAPI-SDK-dotnet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

com.telstra.eventdetection - the C# library for the Telstra Event Detection API

  • API version: 1.0.0
  • SDK version: 1.0.0

Frameworks supported

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)

Dependencies

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using com.telstra.eventdetection.Api;
using com.telstra.eventdetection.Client;
using com.telstra.eventdetection.Model;

Packaging

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out com.telstra.eventdetection.csproj

Getting Started

using System;
using System.Diagnostics;
using com.telstra.eventdetection.Api;
using com.telstra.eventdetection.Client;
using com.telstra.eventdetection.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();
            var clientId = clientId_example;  // string | 
            var clientSecret = clientSecret_example;  // string | 
            var grantType = grantType_example;  // string |  (default to client_credentials)

            try
            {
                // Generate authentication token
                OAuthResponse result = apiInstance.AuthToken(clientId, clientSecret, grantType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.AuthToken: " + e.Message );
            }

        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AuthenticationApi AuthToken POST /v2/oauth/token Generate authentication token
GetSubscriptionApi GetSubscription POST /v1/eventdetection/events/subscriptions Get Event Subscriptions
LongPollApi Longpoll POST /v1/eventdetection/events/{eventType} Poll events
PushNotificationsApi PushNotifications 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

About

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

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages