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 Provisioning API

Create, retrieve, and delete dedicated number subscriptions.

Telstra Provisioning 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 Provisioning. 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 1 path, and defines 3 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 1 paths 3 schemas 1 DELETE1 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 Provisioning 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 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Provisioning 3

Create, retrieve, and delete dedicated number subscriptions.

POST
/messages/provisioning/subscriptions
Telstra Create Subscription
createSubscription body → 201400401
GET
/messages/provisioning/subscriptions
Telstra Get Subscription
getSubscription → 200401404
DELETE
/messages/provisioning/subscriptions
Telstra Delete Subscription
deleteSubscription body → 204401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Subscription (4 properties), CreateSubscriptionRequest (3 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

Subscription
object
4 properties 1 required
ErrorResponse
object
3 properties 3 required
CreateSubscriptionRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telstra-provisioning-api-openapi.yml Raw ↑

Other APIs Telstra publishes across the network.

Telstra Authentication API
Telstra HealthCheck API
Telstra MMS API
Telstra SMS API
Telstra Verification API