Telstra_Messaging

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 2.2.10
• Package version: 1.0.7
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

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

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

Then import the package:

import Telstra_Messaging 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import Telstra_Messaging

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import Telstra_Messaging
from Telstra_Messaging.rest import ApiException
from pprint import pprint


# Defining host is optional and default to https://tapi.telstra.com/v2
configuration.host = "https://tapi.telstra.com/v2"
# Create an instance of the API class
api_instance = Telstra_Messaging.AuthenticationApi(Telstra_Messaging.ApiClient(configuration))
client_id = 'client_id_example' # str | 
client_secret = 'client_secret_example' # str | 
grant_type = 'client_credentials' # str |  (default to 'client_credentials')
scope = 'scope_example' # str | NSMS (optional)

try:
    # Generate OAuth2 token
    api_response = api_instance.auth_token(client_id, client_secret, grant_type, scope=scope)
    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/v2

Class	Method	HTTP request	Description
AuthenticationApi	auth_token	POST /oauth/token	Generate OAuth2 token
MessagingApi	get_mms_status	GET /messages/mms/{messageid}/status	Get MMS Status
MessagingApi	get_sms_status	GET /messages/sms/{messageId}/status	Get SMS Status
MessagingApi	mms_health_check	GET /messages/mms/healthcheck	MMS Health Check
MessagingApi	retrieve_mms_replies	GET /messages/mms	Retrieve MMS Replies
MessagingApi	retrieve_sms_replies	GET /messages/sms	Retrieve SMS Replies
MessagingApi	send_mms	POST /messages/mms	Send MMS
MessagingApi	send_multiple_sms	POST /messages/sms/multi	Send Multiple SMS
MessagingApi	send_sms	POST /messages/sms	Send SMS
MessagingApi	sms_health_check	GET /messages/sms/healthcheck	SMS Health Check
ProvisioningApi	create_subscription	POST /messages/provisioning/subscriptions	Create Subscription
ProvisioningApi	delete_subscription	DELETE /messages/provisioning/subscriptions	Delete Subscription
ProvisioningApi	get_subscription	GET /messages/provisioning/subscriptions	Get Subscription

Documentation For Models

• DeleteNumberRequest
• GetMmsResponse
• GetSubscriptionResponse
• HealthCheckResponse
• InboundPollResponse
• MMSContent
• Message
• MessageMulti
• MessageSentResponseMms
• MessageSentResponseSms
• OAuthResponse
• OutboundPollResponse
• ProvisionNumberRequest
• ProvisionNumberResponse
• SendMmsRequest
• SendSMSRequest
• SendSmsMultiRequest
• Status

Documentation For Authorization

auth

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• NSMS: NSMS

Author