Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telstra SMS API

Send, retrieve, and check status of SMS messages.

Telstra SMS API is one of 6 APIs that Telstra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include SMS. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2.2.10.

Requests are made against a single base URL, https://tapi.telstra.com/v2.

3 operations 2 paths 6 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.2.10
Base URL
https://tapi.telstra.com/v2
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Telstra SMS API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

  • OAuth2ClientCredentials — OAuth 2.0 client credentials grant against https://tapi.telstra.com/v2/oauth/token with the NSMS scope.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

SMS 3

Send, retrieve, and check status of SMS messages.

POST
/messages/sms
Telstra Send SMS
sendSms body → 201400401403429
GET
/messages/sms
Telstra Get SMS Replies
getSmsReplies → 200401
GET
/messages/sms/{messageId}/status
Telstra Get SMS Status
getSmsStatus 1 param → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are SendSmsRequest (10 properties), InboundMessage (7 properties), SendMessageResponse (6 properties), MessageStatus (4 properties). Each schema is shown below with its type and property counts.

MessageReceipt
object
4 properties 3 required
InboundMessage
object
7 properties
SendMessageResponse
object
6 properties 1 required
ErrorResponse
object
3 properties 3 required
MessageStatus
object
4 properties 3 required
SendSmsRequest
object
10 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telstra-sms-api-openapi.yml Raw ↑

Other APIs Telstra publishes across the network.

Telstra Authentication API
Telstra HealthCheck API
Telstra MMS API
Telstra Provisioning API
Telstra Verification API