canonical: https://jentic.com/apis/telstra.com/telstra

# Telstra Messaging API v3.x

Send and receive SMS & MMS programmatically, leveraging Australia's leading mobile network. With Telstra's Messaging API, we take out the complexity to allow seamless messaging integration into your app, with just a few lines of code. Our REST API is enterprise grade, allowing you to communicate with engaging SMS & MMS messaging in your web and mobile apps in near real-time on a global scale. Intr. The API exposes 18 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically create free trial number list, get all free trial numbers. Covers 18 operations with oauth2 authentication.

## Scope

Does not handle payments, crm, or developer tools - use for communications only.

## Capabilities

- create free trial number list
- get all free trial numbers
- health check
- send messages
- fetch all sent/received messages
- update a message

## Use cases

### Communications Operations

Use the Messaging API v3.x to perform communications operations programmatically. The API provides 18 endpoints covering core functionality including create free trial number list, get all free trial numbers, health check.

Example prompt: Call POST /free-trial-numbers to create free trial number list

### Automated Free Trial Numbers Management

Automate free trial numbers operations by combining multiple Messaging API v3.x endpoints. Agents can get all free trial numbers and then health check in a single workflow.

Example prompt: Call GET /free-trial-numbers to get all free trial numbers, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Messaging API v3.x endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'create free trial number list', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/free-trial-numbers` | create free trial number list |
| GET | `/free-trial-numbers` | get all free trial numbers |
| GET | `/health-check` | health check |
| POST | `/messages` | send messages |
| GET | `/messages` | fetch all sent/received messages |
| GET | `/messages/{messageId}` | fetch a specific message |
| PUT | `/messages/{messageId}` | update a message |
| PATCH | `/messages/{messageId}` | update message tags |

## Key resources

- **Free Trial Numbers** — Operations for free trial numbers
- **Health Check** — Operations for health check
- **Messages** — Operations for messages
- **Reports** — Operations for reports
- **Virtual Numbers** — Operations for virtual numbers

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 76 / 100
- **Maturity:** AI-Ready
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 82 / 100
  - AI-Readiness & Agent Experience: 51 / 100
  - Agent Usability: 94 / 100
  - Security: 85 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/telstra.com/telstra/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Telstra Messaging API by hand means running its OAuth2 client-credentials flow to mint scoped tokens, refreshing them, targeting products.api.telstra.com/messaging/v3, and writing the retry glue yourself. Through Jentic you install once, import the Messaging API from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** The Messaging API puts the message id in the URL path (`/messages/{messageId}`), so a rule can pin your agent to one message: it can read and update that message and nothing else. You choose the operations it may call, so ones like provisioning free-trial numbers are not included unless you add them.
- **Credential handling:** Your Telstra client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a message' or 'check message status', and Jentic returns the matching Messaging API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the Messaging API v3.x use?

The Messaging API v3.x uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create free trial number list with the Messaging API v3.x?

Yes. Use the POST /free-trial-numbers endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Messaging API v3.x?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create free trial number list through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create free trial number list'. Jentic returns the matching Messaging API v3.x operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Messaging API v3.x have?

The Messaging API v3.x exposes 18 endpoints covering free trial numbers, health check, messages operations.

### Can I limit what my agent is allowed to do with the Telstra Messaging API?

Yes. Because Jentic One is self-hosted, you write the rules that decide which Telstra Messaging operations and credentials your agent may use. Since the message id sits in the URL path (`/messages/{messageId}`), a rule can pin the agent to a single message so it can only read and update that one and nothing else. You also choose which operations are exposed, so calls like provisioning free-trial numbers stay off-limits unless you add them.
