# Optus

> Optus (Singtel Optus Pty Limited) is Australia's second-largest telecommunications carrier, wholly owned by Singapore's Singtel. Its only genuinely public, self-serve developer surface is The Optus SMS Suite at sms.optus.com.au — an enterprise messaging platform white-labelled from New Zealand's Modica Group, publishing open documentation, downloadable OpenAPI/Swagger definitions, a public WSDL, callback-driven delivery receipts, and a free-trial signup. Everything else in the Optus API estate is partner-gated or absent: developer.optus.com.au and api.optus.com.au resolve on Akamai and return HTTP 403, the IoT Control Centre is a sales-gated Cisco/Jasper platform, and no CAMARA / GSMA Open Gateway API is callable from any Optus host.

Generated by API Evangelist. Optus does not publish an llms.txt of its own (https://sms.optus.com.au/llms.txt returns 404).

Authentication across every messaging interface is HTTP Basic with per-application credentials issued inside the platform. There is no OAuth, no OpenID Connect, no API-key issuance API, and no /.well-known/ discovery surface on any Optus host. There is no idempotency contract, no pagination, no request-id header, and no published rate limit. Delivery outcomes are asynchronous: submits return a message ID, and the result arrives later on a callback URL configured per application.

## APIs with a machine-readable contract

- [SMS Gateway REST API v2](https://sms.optus.com.au/docs/en/integrations/api-documentation/rest-v2/): OpenAPI 3.0.3. Base https://api.sms.optus.com.au/rest/sms/v2. POST /messages (202 Accepted, UUID message ID), GET /messages?id=. Requires a DLR callback URL to see error codes. Recommended for all new integrations.
- [SMS Gateway REST API v1](https://sms.optus.com.au/docs/en/integrations/messaging-apis/sms-apis/rest-v1/): Swagger 2.0. Base https://api.sms.optus.com.au/rest/gateway. POST /messages, POST /messages/broadcast (up to 1000 destinations), GET /messages/{messageid}. 64-bit integer message IDs. Maintain-only; use v2 for new work.
- [Campaign Manager API](https://sms.optus.com.au/docs/en/integrations/messaging-apis/sms-apis/campaign-manager-api/): Swagger 2.0. Base https://api.sms.optus.com.au/rest/campaign_manager/v1. operationIds getLists, createList, deleteList, deleteMultList, scheduleCampaign, getTemplates, getReport. Lists carry up to 1,000,000 members.
- [Health Monitoring API](https://sms.optus.com.au/docs/en/integrations/api-documentation/health-api/): OpenAPI 3.0.0, unauthenticated. Base https://api.sms.optus.com.au/rest/services/v1. GET /status?service=, GET /services. Polled every 60 seconds from an external provider.

## APIs documented without a machine-readable contract

- [2FA REST API](https://sms.optus.com.au/docs/en/integrations/messaging-apis/2fa/): base https://api.sms.optus.com.au/rest/2fa. POST /challenges then POST /responses. Media type application/vnd.modica.2fa.v1+json.
- [REST Email API](https://sms.optus.com.au/docs/en/integrations/api-documentation/rest-email/): base https://api.sms.optus.com.au/rest/email/v1. Plain-text email only, no HTML or attachments.
- [HTTPS API](https://sms.optus.com.au/docs/en/integrations/messaging-apis/sms-apis/https/): base https://api.sms.optus.com.au/message. Legacy GET query-string interface. DEPRECATION ANNOUNCED — expected to be deprecated within 12 months of the notice.
- [SOAP API](https://sms.optus.com.au/docs/en/integrations/messaging-apis/sms-apis/soap/): WSDL at https://api.sms.optus.com.au/ModicaSoap.wsdl, sendMessage operation. DEPRECATION ANNOUNCED — expected to be deprecated within 12 months of the notice.
- [MM7 MMS API](https://sms.optus.com.au/docs/en/integrations/messaging-apis/mm7/): base https://api.sms.optus.com.au/mm7. 3GPP MM7 5.3.0 SOAP multipart MMS.
- [SMPP API](https://sms.optus.com.au/docs/en/integrations/messaging-apis/sms-apis/smpp/): SMPP 3.3 / 3.4 over mandatory TLS 1.2+ on port 2776.

## Specs

- [REST v1 (Swagger 2.0)](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/openapi/optus-sms-suite-rest-v1-openapi.yml)
- [REST v2 (OpenAPI 3.0.3)](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/openapi/optus-sms-suite-rest-v2-openapi.yml)
- [Campaign Manager (Swagger 2.0)](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/openapi/optus-sms-suite-campaign-manager-openapi.yml)
- [Health / Omni Status (OpenAPI 3.0.0)](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/openapi/optus-sms-suite-status-openapi.json)
- [SOAP WSDL (live, provider-hosted)](https://api.sms.optus.com.au/ModicaSoap.wsdl)
- [Campaign Manager swagger.json (live, provider-hosted)](https://api.sms.optus.com.au/rest/campaign_manager/v1/swagger.json)
- [Health swagger.json (live, provider-hosted)](https://api.sms.optus.com.au/rest/services/v1/swagger.json)

## Docs

- [Developer docs index](https://sms.optus.com.au/docs/en/developer-docs/)
- [Getting started for developers](https://sms.optus.com.au/docs/en/developer-getting-started/)
- [Messaging APIs overview](https://sms.optus.com.au/docs/en/integrations/messaging-apis/)
- [Third-party integrations (Genesys, Marketo, Salesforce, Zapier, Okta)](https://sms.optus.com.au/docs/en/integrations/business-integrations/)
- [Security and access](https://sms.optus.com.au/docs/en/security/)
- [SSL certificates and pinning guidance](https://sms.optus.com.au/docs/en/integrations/api-documentation/ssl-certificates/)
- [Message compliance and regulatory information](https://sms.optus.com.au/docs/en/useful-information/message-compliance-and-regulatory-information/)
- [Product news](https://sms.optus.com.au/docs/en/product-news/)
- [Status page](https://status.sms.optus.com.au/)
- [Free trial signup](https://sms.optus.com.au/customer/online_signup)

## API Evangelist artifacts in this repo

- [apis.yml](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/apis.yml)
- [Authentication profile](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/authentication/optus-authentication.yml)
- [API conventions](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/conventions/optus-conventions.yml)
- [Error codes across all interfaces](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/errors/optus-error-codes.yml)
- [Lifecycle, versioning, deprecations and status](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/lifecycle/optus-lifecycle.yml)
- [Conformance and compliance](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/conformance/optus-conformance.yml)
- [Callback surface as AsyncAPI (derived)](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/asyncapi/optus-sms-suite-asyncapi.yml)
- [Data model](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/data-model/optus-data-model.yml)
- [MCP candidate server and tool crosswalk](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/mcp/optus-tool-crosswalk.yml)
- [Agent skills](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/skills/_index.yml)
- [Vulnerability disclosure](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/security/optus-vulnerability-disclosure.yml)
- [Review](https://raw.githubusercontent.com/api-evangelist/optus/refs/heads/main/review.yml)

## Optional

- [Optus corporate site](https://www.optus.com.au/)
- [Optus Vulnerability Disclosure Program (Bugcrowd)](https://bugcrowd.com/optus-vdp-pro)
- [Privacy policy](https://www.optus.com.au/about/legal/privacy)
- [Standard Form of Agreement (business)](https://www.optus.com.au/about/legal/standard-forms-agreement/business)
- [Wikipedia](https://en.wikipedia.org/wiki/Optus)