Telstra_Messaging_Old.MessagingApi

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

Method	HTTP request	Description
get_mms_status	GET /messages/mms/{messageid}/status	Get MMS Status
get_sms_status	GET /messages/sms/{messageId}/status	Get SMS Status
mms_health_check	GET /messages/mms/healthcheck	MMS Health Check
retrieve_mms_replies	GET /messages/mms	Retrieve MMS Replies
retrieve_sms_replies	GET /messages/sms	Retrieve SMS Replies
send_mms	POST /messages/mms	Send MMS
send_multiple_sms	POST /messages/sms/multi	Send Multiple SMS
send_sms	POST /messages/sms	Send SMS
sms_health_check	GET /messages/sms/healthcheck	SMS Health Check

get_mms_status

list[OutboundPollResponse] get_mms_status(messageid)

Get MMS Status

Example

OAuth Authentication (auth):

from __future__ import print_function
import time
import Telstra_Messaging_Old
from Telstra_Messaging_Old.rest import ApiException
from pprint import pprint
configuration = Telstra_Messaging_Old.Configuration()
# Configure OAuth2 access token for authorization: auth
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# 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_Old.MessagingApi(Telstra_Messaging_Old.ApiClient(configuration))
messageid = 'messageid_example' # str | Unique identifier of a message - it is the value returned from a previous POST call to https://tapi.telstra.com/v2/messages/mms 

try:
    # Get MMS Status
    api_response = api_instance.get_mms_status(messageid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->get_mms_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
messageid	str	Unique identifier of a message - it is the value returned from a previous POST call to https://tapi.telstra.com/v2/messages/mms

Return type

list[OutboundPollResponse]

Authorization

auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	Invalid or missing request parameters NOT-PROVISIONED Request flagged as containing suspicious content	-
401	Invalid access token. Please try with a valid token	-
403	Authorization credentials passed and accepted but account does not have permission SpikeArrest-The API call rate limit has been exceeded	-
404	The requested URI does not exist OLD-NONEXISTANT-MESSAGE-ID RESOURCE-NOT-FOUND	-
405	The requested resource does not support the supplied verb	-
415	API does not support the requested content type	-
422	The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided in the request	-
500	Technical error : Unable to route the message to a Target Endpoint : An error has occurred while processing your request, please refer to API Docs for summary on the issue	-
501	The HTTP method being used has not yet been implemented for the requested resource	-
503	The service requested is currently unavailable	-
0	An internal error occurred when processing the request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_sms_status

list[OutboundPollResponse] get_sms_status(message_id)

Get SMS Status

If no notification URL has been specified, it is possible to poll for the message status. Note that the MessageId that appears in the URL must be URL encoded. Just copying the MessageId as it was supplied when submitting the message may not work. # SMS Status with Notification URL When a message has reached its final state, the API will send a POST to the URL that has been previously specified.

<code class="language-sh">{     "to": "+61418123456",     "sentTimestamp": "2017-03-17T10:05:22+10:00",     "receivedTimestamp": "2017-03-17T10:05:23+10:00",     "messageId": "1234567890ABCDEFGHIJKLNOPQRSTUVW",     "deliveryStatus": "DELIVRD"   }

The fields are: | Field | Description | | --- | ---| | to | The number the message was sent to. | | receivedTimestamp | Time the message was sent to the API. | | sentTimestamp | Time handling of the message ended. | | deliveryStatus | The final state of the message. | | messageId | The same reference that was returned when the original message was sent.| | receivedTimestamp | Time the message was sent to the API.| Upon receiving this call it is expected that your servers will give a 204 (No Content) response.

Example

OAuth Authentication (auth):

from __future__ import print_function
import time
import Telstra_Messaging_Old
from Telstra_Messaging_Old.rest import ApiException
from pprint import pprint
configuration = Telstra_Messaging_Old.Configuration()
# Configure OAuth2 access token for authorization: auth
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# 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_Old.MessagingApi(Telstra_Messaging_Old.ApiClient(configuration))
message_id = 'message_id_example' # str | Unique identifier of a message - it is the value returned from a previous POST call to https://tapi.telstra.com/v2/messages/sms. 

try:
    # Get SMS Status
    api_response = api_instance.get_sms_status(message_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->get_sms_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
message_id	str	Unique identifier of a message - it is the value returned from a previous POST call to https://tapi.telstra.com/v2/messages/sms.

Return type

list[OutboundPollResponse]

Authorization

auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Invalid or missing request parameters NOT-PROVISIONED Request flagged as containing suspicious content	-
401	Invalid access token. Please try with a valid token	-
403	Authorization credentials passed and accepted but account does not have permission SpikeArrest-The API call rate limit has been exceeded	-
404	The requested URI does not exist OLD-NONEXISTANT-MESSAGE-ID RESOURCE-NOT-FOUND	-
405	The requested resource does not support the supplied verb	-
415	API does not support the requested content type	-
422	The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided in the request	-
500	Technical error : Unable to route the message to a Target Endpoint : An error has occurred while processing your request, please refer to API Docs for summary on the issue	-
501	The HTTP method being used has not yet been implemented for the requested resource	-
503	The service requested is currently unavailable	-
0	An internal error occurred when processing the request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

mms_health_check

HealthCheckResponse mms_health_check()

MMS Health Check

Determine whether the MMS service is up or down.

Example

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

# Create an instance of the API class
api_instance = Telstra_Messaging_Old.MessagingApi()

try:
    # MMS Health Check
    api_response = api_instance.mms_health_check()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->mms_health_check: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

HealthCheckResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
500	Technical error : Unable to route the message to a Target Endpoint : An error has occurred while processing your request, please refer to API Docs for summary on the issue	-
501	The HTTP method being used has not yet been implemented for the requested resource	-
503	The service requested is currently unavailable	-
0	An internal error occurred when processing the request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_mms_replies

GetMmsResponse retrieve_mms_replies()

Retrieve MMS Replies

Messages are retrieved one at a time, starting with the earliest reply. If the subscription has a notifyURL, reply messages will be logged there instead, i.e. GET and reply notifyURL are exclusive. # MMS Reply with Notification URL When a reply is received, the API will send a POST to the subscription URL that has been previously specified.

<code class="language-sh">{   "to": "+61418123456",   "from": "+61421987654",   "sentTimestamp": "2018-03-23T12:15:45+10:00",   "messageId": "XFRO1ApiA0000000111",   "subject": "Foo",   "envelope": "string",   "MMSContent":     [       {         "type": "text/plain",         "filename": "text_1.txt",         "payload": "string"       },       {         "type": "image/jpeg",         "filename": "sample.jpeg",         "payload": "string"       }     ] }

The fields are: | Field | Description | | --- | --- | | to |The number the message was sent to. | | from | The number the message was sent from. | | sentTimestamp | Time handling of the message ended. | | messageId | Message Id assigned by the MMSC | | subject | The subject assigned to the message. | | envelope | Information about terminal type and originating operator. | | MMSContent | An array of the actual content of the reply message. | | type | The content type of the message. | | filename | The filename for the message content. | | payload | The content of the message. |

Example

OAuth Authentication (auth):

from __future__ import print_function
import time
import Telstra_Messaging_Old
from Telstra_Messaging_Old.rest import ApiException
from pprint import pprint
configuration = Telstra_Messaging_Old.Configuration()
# Configure OAuth2 access token for authorization: auth
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# 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_Old.MessagingApi(Telstra_Messaging_Old.ApiClient(configuration))

try:
    # Retrieve MMS Replies
    api_response = api_instance.retrieve_mms_replies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->retrieve_mms_replies: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetMmsResponse

Authorization

auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Invalid or missing request parameters NOT-PROVISIONED Request flagged as containing suspicious content	-
401	Invalid access token. Please try with a valid token	-
403	Authorization credentials passed and accepted but account does not have permission SpikeArrest-The API call rate limit has been exceeded	-
404	The requested URI does not exist RESOURCE-NOT-FOUND	-
405	The requested resource does not support the supplied verb	-
415	API does not support the requested content type	-
422	The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided in the request	-
500	Technical error : Unable to route the message to a Target Endpoint : An error has occurred while processing your request, please refer to API Docs for summary on the issue	-
501	The HTTP method being used has not yet been implemented for the requested resource	-
503	The service requested is currently unavailable	-
0	An internal error occurred when processing the request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve_sms_replies

InboundPollResponse retrieve_sms_replies()

Retrieve SMS Replies

Messages are retrieved one at a time, starting with the earliest reply. The API supports the encoding of emojis in the reply message. The emojis will be in their UTF-8 format. If the subscription has a notifyURL, reply messages will be logged there instead. # SMS Reply with Notification URL When a reply is received, the API will send a POST to the subscription URL that has been previously specified.

<code class="language-sh">{   "to":"+61472880123",   "from":"+61412345678",   "body":"Foo4",   "sentTimestamp":"2018-04-20T14:24:35",   "messageId":"DMASApiA0000000146" }

The fields are: | Field | Description | | --- |--- | | to | The number the message was sent to. | | from | The number the message was sent from. | | body | The content of the SMS response. | | sentTimestamp | Time handling of the message ended. | | messageId | The ID assigned to the message. |

Example

OAuth Authentication (auth):

from __future__ import print_function
import time
import Telstra_Messaging_Old
from Telstra_Messaging_Old.rest import ApiException
from pprint import pprint
configuration = Telstra_Messaging_Old.Configuration()
# Configure OAuth2 access token for authorization: auth
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# 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_Old.MessagingApi(Telstra_Messaging_Old.ApiClient(configuration))

try:
    # Retrieve SMS Replies
    api_response = api_instance.retrieve_sms_replies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->retrieve_sms_replies: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InboundPollResponse

Authorization

auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Invalid or missing request parameters NOT-PROVISIONED Request flagged as containing suspicious content	-
401	Invalid access token. Please try with a valid token	-
403	Authorization credentials passed and accepted but account does not have permission SpikeArrest-The API call rate limit has been exceeded	-
404	The requested URI does not exist RESOURCE-NOT-FOUND	-
405	The requested resource does not support the supplied verb	-
415	API does not support the requested content type	-
422	The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided in the request	-
500	Technical error : Unable to route the message to a Target Endpoint : An error has occurred while processing your request, please refer to API Docs for summary on the issue	-
501	The HTTP method being used has not yet been implemented for the requested resource	-
503	The service requested is currently unavailable	-
0	An internal error occurred when processing the request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

send_mms

MessageSentResponseMms send_mms(body)

Send MMS

Example

OAuth Authentication (auth):

from __future__ import print_function
import time
import Telstra_Messaging_Old
from Telstra_Messaging_Old.rest import ApiException
from pprint import pprint
configuration = Telstra_Messaging_Old.Configuration()
# Configure OAuth2 access token for authorization: auth
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# 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_Old.MessagingApi(Telstra_Messaging_Old.ApiClient(configuration))
body = Telstra_Messaging_Old.SendMmsRequest() # SendMmsRequest | A JSON or XML payload containing the recipient's phone number and MMS message. The recipient number should be in the format '04xxxxxxxx' where x is a digit. 

try:
    # Send MMS
    api_response = api_instance.send_mms(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->send_mms: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SendMmsRequest	A JSON or XML payload containing the recipient's phone number and MMS message. The recipient number should be in the format '04xxxxxxxx' where x is a digit.

Return type

MessageSentResponseMms

Authorization

auth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Invalid or missing request parameters MMS-TYPE-MISSING MMS-PAYLOAD-MISSING MMS-FILENAME-MISSING DELIVERY-IMPOSSIBLE TO-MSISDN-NOT-VALID SENDER-MISSING DELIVERY-IMPOSSIBLE SUBJECT-TOO-LONG FROM-MSISDN-TOO-LONG TO-MSISDN-TOO-LONG NOT-PROVISIONED Request flagged as containing suspicious content	-
401	Invalid access token. Please try with a valid token	-
403	* Authorization credentials passed and accepted but account does not have permission. * SpikeArrest. The API call rate limit has been exceeded * MSG_Monetization_ERR. Credit Card monthly limit may have been reached.	-
404	RESOURCE-NOT-FOUND. The requested URI does not exist	-
405	The requested resource does not support the supplied verb	-
415	API does not support the requested content type	-
422	The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided in the request	-
500	Technical error : Unable to route the message to a Target Endpoint : An error has occurred while processing your request, please refer to API Docs for summary on the issue	-
501	The HTTP method being used has not yet been implemented for the requested resource	-
503	The service requested is currently unavailable	-
0	An internal error occurred when processing the request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

send_multiple_sms

MessageSentResponseSms send_multiple_sms(payload)

Send Multiple SMS

Send multiple SMS in one API call.

Example

OAuth Authentication (auth):

from __future__ import print_function
import time
import Telstra_Messaging_Old
from Telstra_Messaging_Old.rest import ApiException
from pprint import pprint
configuration = Telstra_Messaging_Old.Configuration()
# Configure OAuth2 access token for authorization: auth
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# 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_Old.MessagingApi(Telstra_Messaging_Old.ApiClient(configuration))
payload = Telstra_Messaging_Old.SendSmsMultiRequest() # SendSmsMultiRequest | A JSON payload containing the recipient's phone number and text message. This number can be in international format if preceeded by a '+' or in national format ('04xxxxxxxx') where x is a digit. 

try:
    # Send Multiple SMS
    api_response = api_instance.send_multiple_sms(payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->send_multiple_sms: %s\n" % e)

Parameters

Name	Type	Description	Notes
payload	SendSmsMultiRequest	A JSON payload containing the recipient's phone number and text message. This number can be in international format if preceeded by a '+' or in national format ('04xxxxxxxx') where x is a digit.

Return type

MessageSentResponseSms

Authorization

auth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Invalid or missing request parameters * DR-NOTIFY-URL-MISSING. `"receiptOff"` is missing or `"receiptOff":"false"` but notifyURL is missing	-
403	* Authorization credentials passed and accepted but account does not have permission. * SpikeArrest. The API call rate limit has been exceeded * MSG_Monetization_ERR. Credit Card monthly limit may have been reached.	-
500	Technical error : Unable to route the message to a Target Endpoint : An error has occurred while processing your request, please refer to API Docs for summary on the issue	-
501	The HTTP method being used has not yet been implemented for the requested resource	-
503	The service requested is currently unavailable	-
0	An internal error occurred when processing the request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

send_sms

MessageSentResponseSms send_sms(payload)

Send SMS

Send an SMS Message to a single or multiple mobile number/s.

Example

OAuth Authentication (auth):

from __future__ import print_function
import time
import Telstra_Messaging_Old
from Telstra_Messaging_Old.rest import ApiException
from pprint import pprint
configuration = Telstra_Messaging_Old.Configuration()
# Configure OAuth2 access token for authorization: auth
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# 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_Old.MessagingApi(Telstra_Messaging_Old.ApiClient(configuration))
payload = Telstra_Messaging_Old.SendSMSRequest() # SendSMSRequest | A JSON or XML payload containing the recipient's phone number and text message. This number can be in international format if preceeded by a '+' or in national format ('04xxxxxxxx') where x is a digit. 

try:
    # Send SMS
    api_response = api_instance.send_sms(payload)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->send_sms: %s\n" % e)

Parameters

Name	Type	Description	Notes
payload	SendSMSRequest	A JSON or XML payload containing the recipient's phone number and text message. This number can be in international format if preceeded by a '+' or in national format ('04xxxxxxxx') where x is a digit.

Return type

MessageSentResponseSms

Authorization

auth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Invalid or missing request parameters * TO-MSISDN-NOT-VALID * SENDER-MISSING * DELIVERY-IMPOSSIBLE * FROM-MSISDN-TOO-LONG * BODY-TOO-LONG * BODY-MISSING * TO-MSISDN-TOO-LONG * TECH-ERR * BODY-NOT-VALID * NOT-PROVISIONED * Request flagged as containing suspicious content. * Invalid 'from' address specified.	-
401	Invalid access token. Please try with a valid token	-
403	* Authorization credentials passed and accepted but account does not have permission. * SpikeArrest. The API call rate limit has been exceeded * MSG_Monetization_ERR. Credit Card monthly limit may have been reached.	-
404	RESOURCE-NOT-FOUND. The requested URI does not exist	-
405	The requested resource does not support the supplied verb	-
415	API does not support the requested content type	-
422	The request is formed correctly, but due to some condition the request cannot be processed e.g. email is required and it is not provided in the request	-
500	Technical error : Unable to route the message to a Target Endpoint : An error has occurred while processing your request, please refer to API Docs for summary on the issue	-
501	The HTTP method being used has not yet been implemented for the requested resource	-
503	The service requested is currently unavailable	-
0	An internal error occurred when processing the request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sms_health_check

HealthCheckResponse sms_health_check()

SMS Health Check

Determine whether the SMS service is up or down.

Example

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

# Create an instance of the API class
api_instance = Telstra_Messaging_Old.MessagingApi()

try:
    # SMS Health Check
    api_response = api_instance.sms_health_check()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagingApi->sms_health_check: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

HealthCheckResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
500	Technical error : Unable to route the message to a Target Endpoint : An error has occurred while processing your request, please refer to API Docs for summary on the issue	-
501	The HTTP method being used has not yet been implemented for the requested resource	-
503	The service requested is currently unavailable	-
0	An internal error occurred when processing the request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MessagingApi.md

Latest commit

History

MessagingApi.md

File metadata and controls

Telstra_Messaging_Old.MessagingApi

get_mms_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_sms_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

mms_health_check

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retrieve_mms_replies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

retrieve_sms_replies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

send_mms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

send_multiple_sms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

send_sms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

sms_health_check

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details