How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Optus Messages API

The Messages API from Optus — 3 operation(s) for messages.

Optus Messages API is one of 15 APIs that Optus publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Message. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 4 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.sms.optus.com.au/rest/gateway, https://api.sms.optus.com.au/rest/sms/v2.

4 operations 3 paths 11 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.sms.optus.com.au/rest/gateway
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

Optus Messages API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as Authorization (GatewayAuthorizer).

  • GatewayAuthorizer — HTTP Basic Authentication is used for all authenticated requests.

Paths & Operations 4

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

Messages 4
POST
/messages
Send a message to a single mobile
body → 201default
GET
/messages
Get message details for an existing message
1 param → 200default
POST
/messages/broadcast
Send a message to an array of mobiles
body → 201default
GET
/messages/{messageid}
Retreives detail of an already created message
1 param → 200default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are SingleMessage (10 properties), MessageCommon (8 properties), MessageDetails (7 properties), ReplyCallback (5 properties). Each schema is shown below with its type and property counts.

MessageBroadcast
object
Send a message to multiple handsets
1 required
Message
object
Send a message to one handset
1 required
MessageCommon
object
Common properties for single and broadcast messages
8 properties 1 required
DefaultError
object
2 properties 2 required
RestResponse
array
BroadcastRestResponse
array
ReplyCallback
object
5 properties
SingleMessage
object
10 properties 2 required
Uuid
string
A string with UUID format.
MessageDetails
object
Message details structure.
7 properties
StatusCallback
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optus-messages-api-openapi.yml Raw ↑

Other APIs Optus publishes across the network.

Optus SMS Suite 2FA REST API
Optus SMS Suite REST Email API
Optus SMS Suite HTTPS API
Optus SMS Suite SOAP API
Optus SMS Suite MMS MM7 API
Optus SMS Suite SMPP API
Optus Delete Multiple Lists API
Optus Documentation API
Optus Lists API
Optus Report API
Optus Scheduled Campaigns API
Optus Services API
Where this information came from

This is an independent, third-party profile of Optus Messages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.