Renewal Notifications

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.

Billing for subscription services is done at the carrier level on billing on some carriers. This contrasts to the normal SMS billing model where each charge to the end-user can be attributed to a particular MO or premium MT SMS. The MX Telecom SMS Gateway can inform partners of carrier-level subscription renewals via an HTTP interface.

Enabling renewal notifications

Renewal notifications are enabled on a per-account basis. Please contact us with a URL to which renewal notifications should be posted to have this enabled on one or more of your SMS Gateway accounts.

Supported carriers

Renewal notifications are only applicable to carriers which manage subscription renewals themselves. At present this is limited to:

Notification format

An HTTP GET request will be made to the configured URL by the SMS Gateway for each renewal. The following parameters will be present in the GET request:

Parameter Always present? Meaning
network Yes Carrier code for end-user's carrier.
shortcode Yes The Short Code for the subscripion.
msisdn Yes Subscribed cell phone number.
smsid Yes The SMS ID which was returned by the SMS Gateway when the subscription was set up. This is a positive 64 bit integer used to uniquely identify the SMS message.
date Yes The date and time at which the renewal occurred. Format is "yyyy-MM-dd HH:mm:ss" in London UK time.
mtusername Yes * The SMS Gateway MT account associated with the subscription.

* May not be present for some older integrations.

The following is an example renewal notification. The renewal occured at 2008-01-01 00:12:20, for a subscription which was set up by an SMS message with the SMS ID 12345678 for cell phone number 16463211246, which is on AT&T Mobility:

http://server.example.com/Renewals?msisdn=16463211246&smsid=12345678&date=2008-01-01+00:12:20&network=CINGULARUS&shortcode=10990&mtusername=uscitraffictxt2

Your server should return an HTTP 200 response with a non-empty body.

NOTE:

When sending HTTP GETs we will retry a request which fails after a timeout (currently 60 seconds), or which returns a non-200 response. It is the partner's responsibility to filter duplicate requests - these might occur if for some reason we did not receive the HTTP response from a previous attempt within 60 seconds.

To ensure the authenticity of the HTTP requests, you should only accept requests from the following IP addresses:

  • 83.166.68.0 - 83.166.69.255 (83.166.68.0/23)
  • 83.166.72.0 - 83.166.72.255 (83.166.72.255/24)
  • 208.93.48.0 - 208.93.51.255 (208.93.48.0/22)

The HTTP endpoint can be an HTTPS (SSL) URL to protect the data whilst in transit.

For more information, please contact us at 1-877-698-3532 or via email at sales@uk.openmarket.com.