Before you can try the API, you will need to have a registered account with an approved App containing this API Product. Find your App details under My Apps.

OAuth

Method
Description

POST

Get Token

https://api.telstra.com/v1/oauth/token

Gets an OAuth 2.0 access token that can be used to make other API calls. You will need to pass in your Consumer Key and Consumer Secret, set the grant_type to 'client_credentials' and set the relevant scope. You can get your Consumer Key and Consumer Secret from My Apps. To set the scope, refer to the Getting Started guide of the API you want to call for more information (e.g. for an SMS authentication token set the scope as ‘SMS’).

SMS

Method
Description

POST

Send SMS

https://api.telstra.com/v1/sms/messages

Sends a SMS to a single Australia mobile phone number. A unique identifier (messageId) returned in the response, which may be used to query for the delivery status of the message.

GET

Get Message Status

https://api.telstra.com/v1/sms/messages/{messageId}

Use the unique identifier (messageId) returned as returned in the response from the Send SMS method to get the status.

GET

Get Message Response

https://api.telstra.com/v1/sms/messages/{messageId}/response

The recipients of your SMS messages can send a reply which you can retrieve using the Get Message Response method. Pass through the unique identifier (messageId) returned as returned in the response from the Send SMS method and you will receive the reply and the timestamp.