MX Telecom SMS Gateway HTTP Interface

Overview

OpenMarket now offers a RESTful and feature-rich Global SMS API. Compared to the existing MX Telecom APIs, the Global SMS API provides:

  • Automated originator selection, which selects the correct short code or VMN for any country or territory
  • Our highest level SLA and increased messaging capacity
  • Better security through Basic authentication
  • A test environment for new and migrating customers

as well as a host of other benefits. While we will continue to support our existing SMS APIs, we believe that our Global SMS API offers some exciting features and benefits that you'll want to take advantage of, and future feature development will be focused on the Global SMS API. For more information, see the Release Note on our Docs and Resources website.

Note that currently the Global SMS API does not support Premium Rate messaging. Existing Premium Rate customers should continue to use the MX Telecom APIs.

The HTTP Interface is the most popular direct interface for the SMS Gateway, as it is simple to implement and provides a fuller feature set than SMPP.

Features

You can use the HTTP interface to send and receive SMS messages of any type, such as:

  • plain text messages
  • content messages such as WAP Push messages and MMS notifications
  • vCard messages
  • messages with User Data Header (UDH) information
  • 8-Bit binary messages

For all messages sent through the SMS Gateway, you can optionally receive a range of detailed delivery reports.

The interface supports both HTTP and HTTPS requests, and HTTP 1.1 for persistent connections.

Benefits over SMPP

The benefits of using the HTTP interface over the SMPP interface are:

  • ability to send an SMS to multiple recipients in one request
  • automatic multipart SMS messaging for long text messages
  • access to refund and renewal notifications

Requirements

Your platform will need to be able to send and receive HTTP or HTTPS GET and POST requests.

You will also need to provide a URL for incoming notifications from the SMS Gateway about the status of sent messages and to receive SMS messages.

Security

The SMS Gateway exposes an HTTPS interface for all request types.

For extra security, you can submit a whitelist of IP addresses from which the SMS Gateway will accept mesage requests for your account.

Sending a Single SMS

An overview of how to send an SMS to a single recipient using the HTTP GET or POST request method.

Broadcasting an SMS

An overview of how to send an SMS to a multiple recipients using the HTTP POST request method.

Sending Reference

The API reference for sending an SMS of any message type.

Receiving Delivery Reports

The API reference for receiving a delivery report.

Receiving an SMS

An overview and API reference for receiving an SMS.

Refund Notifications

An overview and API reference for receiving refund notifications.

Renewal Notifications

An overview and API reference for receiving renewal notifications.