Telstra

Telstra HealthCheck API

Service health checks for SMS and MMS messaging surfaces.

GitHub OpenAPI

Documentation

📖
Documentation
https://dev.telstra.com

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/telstra/refs/heads/main/openapi/telstra-healthcheck-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/telstra/refs/heads/main/json-schema/telstra-message-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/telstra/refs/heads/main/json-schema/telstra-subscription-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/telstra/refs/heads/main/json-structure/telstra-message-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/telstra/refs/heads/main/json-ld/telstra-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/telstra/refs/heads/main/examples/telstra-send-sms-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/telstra/refs/heads/main/examples/telstra-create-subscription-example.json
🔗
SDKs
https://github.com/telstra/MessagingAPI-SDK-python
🔗
SDKs
https://github.com/telstra/MessagingAPI-SDK-node
🔗
SDKs
https://github.com/telstra/MessagingAPI-SDK-Java
🔗
SDKs
https://github.com/telstra/MessagingAPI-SDK-dotnet
🔗
SDKs
https://github.com/telstra/MessagingAPI-SDK-Go

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/telstra-healthcheck-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

telstra-healthcheck-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Telstra Messaging Authentication HealthCheck API
  description: 'The Telstra Messaging API provides programmatic SMS and MMS messaging

    services in Australia and select international destinations. Built on

    the Telstra mobile network, the API supports outbound and inbound

    SMS/MMS, delivery status callbacks, virtual numbers, and provisioning

    workflows. Authentication uses OAuth 2.0 client credentials with the

    NSMS scope.

    '
  version: 2.2.10
  contact:
    name: Telstra Developer Support
    url: https://dev.telstra.com
  termsOfService: https://www.telstra.com.au/business-enterprise/legal/messaging-api-terms-of-service
  license:
    name: Telstra Developer License
    url: https://github.com/telstra/tdev-doc-license
  x-logo:
    url: https://www.telstra.com.au/etc/designs/telstrav8/clientlibs/img/Telstra_Symbol.svg
servers:
- url: https://tapi.telstra.com/v2
  description: Production Server
security:
- OAuth2ClientCredentials:
  - NSMS
tags:
- name: HealthCheck
  description: Service health checks for SMS and MMS messaging surfaces.
paths:
  /messages/sms/healthcheck:
    get:
      summary: Telstra SMS Healthcheck
      description: Service availability indicator for SMS messaging.
      operationId: smsHealthcheck
      tags:
      - HealthCheck
      security: []
      responses:
        '200':
          description: Service is operational.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '503':
          description: Service is degraded or unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
  /messages/mms/healthcheck:
    get:
      summary: Telstra MMS Healthcheck
      description: Service availability indicator for MMS messaging.
      operationId: mmsHealthcheck
      tags:
      - HealthCheck
      security: []
      responses:
        '200':
          description: Service is operational.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
components:
  schemas:
    HealthCheckResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - up
          - down
  securitySchemes:
    OAuth2ClientCredentials:
      type: oauth2
      description: OAuth 2.0 client credentials grant against https://tapi.telstra.com/v2/oauth/token with the NSMS scope.
      flows:
        clientCredentials:
          tokenUrl: https://tapi.telstra.com/v2/oauth/token
          scopes:
            NSMS: Send and receive SMS/MMS through Telstra Messaging.