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 SMS Suite REST API v1

JSON REST API for sending single and bulk SMS from The Optus SMS Suite, including scheduled sends, broadcast to a list, and retrieval of a submitted message by 64-bit message ID. Authenticated with HTTP Basic credentials issued per application in the SMS Suite platform.

Optus SMS Suite REST API v1 is one of 10 APIs that Optus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against the base URL https://api.sms.optus.com.au/rest/gateway.

3 operations 3 paths 6 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://api.sms.optus.com.au/rest/gateway
Authentication
basic
Resource Areas
1

Authentication & Security 1

Optus SMS Suite REST API v1 declares 1 security scheme for authenticating requests. It defines a basic scheme (BasicAuth). By default, every request must be authenticated.

Paths & Operations 3

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

Operations 3
POST
/messages
Send a message to a single mobile
1 param → 201default
POST
/messages/broadcast
Send a message to an array of mobiles
1 param → 201default
GET
/messages/{messageid}
Retreives detail of an already created message
1 param → 200default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are MessageCommon (8 properties), DefaultError (2 properties). Each schema is shown below with its type and property counts.

DefaultError
object
2 properties 2 required
MessageCommon
object
Common properties for single and broadcast messages
8 properties 1 required
MessageBroadcast
object
Send a message to multiple handsets
1 required
Message
object
Send a message to one handset
1 required
RestResponse
array
BroadcastRestResponse
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optus-sms-suite-rest-v1-openapi.yml Raw ↑

Other APIs Optus publishes across the network.

Optus SMS Suite SMS Gateway REST API v2
Optus SMS Suite Campaign Manager API
Optus SMS Suite Health Monitoring API
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
Where this information came from

This is an independent, third-party profile of Optus SMS Suite REST API v1, 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.