Migrate to v4 SMPP

The following describes the changes for OpenMarket's SMPP Global SMS API implementation of the SMPP Protocol Specification v3.4, as well as the steps to migrate from our v3 SMPP implementation.

Important: If you are currently using OpenMarket’s v3 SMPP or the UK SMPP API, and are interested in migrating to v4, please contact your OpenMarket account manager

In this topic:

What's supported in this release?

This release includes new and updated support for the following:

  • Custom Type-length-values (TLVs): In OpenMarket's version 3 of SMPP, you were required to use custom TLVs even if you did not want to use them. When you’re provisioned you can how choose whether or not to integrate them. If you choose not to integrate custom TLVs, you’ll still have access to the core SMPP operations described below.
  • Service Type Parameter: A new service_type parameter for MTs and MOs allows you to specify that this is a request for v4. If the parameter is not passed, OpenMarket processes the request as a legacy v3 request. When your account is provisioned, you can select to have all of your MTs and MOs use the version 4 parameter by default.
  • Increased Password Length: Password length has been increased to 100 characters. By increasing password length, you can add a greater level of security to safeguard your environment.
  • Connect to a single data source: Both the new version and the legacy v3 version now connect to a single data source, smppgw.openmarket.com. This allows for simpler reporting.
  • Automated Originator Selector: AOS works with OpenMarket's version 4 implementation of both SMPP and HTTP.

Custom TLVs

This release no longer requires the use of custom TLVs. Without using custom TLVs you'll still have access to the core Gateway functionality. And while custom TLVs are not required, they can still be optionally used with the Mobile Originated (MO), and Delivery Receipt operations. By default, custom TLVs are enabled on your account. By default, when your account is provisioned TLVs are not enabled; however, you can easily enable TLVs on your account during provisioning.

OpenMarket Custom TLVs

Operation

Supported Custom TLVs
Delivery Receipt. See Receive a delivery receipt for more information about each TLV.
  • Operator ID: The mobile operator identifier.
  • Note 1: Allows you to pass any additional information in a delivery receipt.
  • Note 2: Allows you to pass any other additional information in a delivery receipt.
  • Status Code: The delivery receipt status code.
  • Status Code Description: Description of the associated Status Code.
Mobile Originated (MO). See Receive a Mobile Originated (MO) message for more information about this TLV.
  • Operator ID: The mobile operator identifier.
Mobile Terminated (MT). Send a Mobile Terminated (MT) message for more information about this TLV.
  • Operator ID: The mobile operator identifier.
  • Note 1: Allows you to pass any additional information in a delivery receipt.
  • Note 2: Allows you to pass any other additional information in a delivery receipt.
  • Program ID: Identifies a pre-provisioned program linked to a short code messaging service.
  • Interaction: Indicates whether or not a message is one-way or two-way.
  • Promotional: Indicates whether or not a message is promotional.

New command status codes for MT messages

New TLV status codes using the 0x400 range are now included for the MT operation. When TLVs are enabled on your account, these status codes will return information about your MTs. See OpenMarket submit_sm_resp command status codes for custom TLVs.

MO and Delivery Receipt flow control windowing

OpenMarket limits the number of unacknowledged MOs and DRs sent on SMPP binds to your account at any point in time. Unacknowledged MOs and DRs are limited to avoid sending a higher rate of MOs and DRs to your system than can be processed. When a new a new account is provisioned for your OpenMarket account using SMPP, a default MO and DR flow control window of 100 unacknowledged MOs & DRs (combined) per bind is set on an OpenMarket SMPP gateway host. See MO and Delivery Receipt flow control windowing for more information.

Removed TLVs

Support for the following OpenMarket custom TLVs for MT messages in OpenMarket's v4 implementation of SMPP. It can still be used, however, if you’re using v3 or the UK SMPP API.

TLV Name

Tag

Type
Charge Type 0x2151 byte

New and changed terminology

  • Message originators —This is our term for the text-able numbers (or alphanumeric strings) you use to send and receive messages.
  • Interaction — Interactions identifies whether your messaging is one-way or two-way.
  • Mobile operators — We have changed from using the term "carrier" to "mobile operator". This term is better understood globally.

Migrating from v3 SMPP

If you're currently using either our v3 or the UK SMPP API, take these steps to migration to v4:

  • Read these release notes to understand new features and the differences between the legacy versions and v4.
  • Contact your OpenMarket account manager to make sure your OpenMarket account is properly provisioned.
  • Use our Customer Integration Environment (CIE) to test your operations.
  • Notify OpenMarket Support when you want to start receiving MO messages.
  • MTs and MOs support the DCS-3 data coding scheme.

Migrating from the UK SMPP API

This new version of SMPP does not support OpenMarket's Premium SMS Service for messages sent to the UK and Australia. If you use the Premium SMS Service you will not be able to migrate to the new version of SMPP. Additionally, the UK SMPP API uses some TLVs that are not currently available in this new version, such as Age Verification or Location-based Services. For a list of the UK SMPP TLVs, see UK SMPP TLVs. To verify whether or not you can migrate to the new version you'll need to check with your Account Manager.

If you only do US or Canadian SMS and are on the UK SMPP API You can migrate to the new version, although you will need to work with your Account Manager to move any short codes or VMNs to the new platform.