v3 SMS SMPP
Required SMPP Settings for Each Region
You may need to configure your SMPP requests based on the region you are messaging. This is split into the following:
- United States and Canada
- India
- International (rest of world)
If you decide to begin messaging another region, make sure you first contact your OpenMarket account manager, as we will need to give your account access to each country, and determine whether you need any numbers provisioned for two-way messaging.
International
When sending international messages, you'll need to include the OpenMarket custom TLV Charge type. Set this in your request to 20.
See OpenMarket TLV Parameters.
Required parameters
Parameter |
Description |
---|---|
Source TON |
The type of number (TON). Set this to either:
Values: 0x01, 0x03, 0x05 (hex) |
Source NPI |
Set the Source NPI (numbering plan indicator) to unknown; 0x01 is also acceptable; OpenMarket recommends 0x00 for unknown. Value: 0x00 (hex) |
Source Address |
Use an alphanumeric source address or format the using the international E.164 format; <country code> followed by the <national number>. Values:
|
Destination TON |
Set type of number set to international: 0x01. Value: 0x01 (hex) |
Destination NPI |
Set to ISDN/E.164; OpenMarket recommends 0x01. Value: 0x01 (hex) |
Destination Address |
Format the Destination Address of the recipient using the international E.164 format; <country code> followed by the <national number>. For example, use country code 44 for UK phone numbers. If you use Destination TON 0x1, format the destination address as follows: <country code><national number>. For example: 442081234567 If you use Destination TON 0x0, format the destination address as follows with a leading plus sign: +<country code><national number>. For example: +442081234567 Value: maximum 20 digits (C Octet String) |
Charge Type |
Use charge type 0x14 (20 decimal) to designate the MT as international rate. Value: 0x14 |
Registered Delivery |
To determine if a message was delivered to a device, you can request a message delivery receipt when you submit the message by setting registered_delivery to 1. Intermediate delivery receipts are not supported. |
United States and Canada
In order to send SMS MTs to the United States and Canada, you will need a two-way capable number, such as a short code, virtual mobile number, or SMS-enabled toll-free or landline number.
In your request, you'll need to include the OpenMarket custom TLV Program ID.
You may also wish to set the custom TLV Carrier ID for short code messaging. Do not include a carrier ID when submitting MTs from landline numbers and US virtual mobile numbers. Mobile operator routing is determined dynamically. You will not be charged for a dynamic operator look-up on MTs from landline numbers; if you submit a carrier ID it will be ignored. You may include a carrier ID when submitting MTs from toll free numbers.
See OpenMarket TLV Parameters.
Required parameters for a short code
Parameter |
Description |
---|---|
Source TON |
Indicates the type of number (TON). Set to network-specific. Value: 0x03 (hex) |
Source NPI |
Set the Source NPI (numbering plan indicator) to unknown. 0x01 is also acceptable. OpenMarket recommends 0x00 for unknown. Value: 0x00 (hex) |
Source Address |
Set Source Address to your assigned short code. Value: maximum 20 digits (C Octet String) |
Destination TON |
Set the type of number to international (0x01). Value: 0x01 (hex) |
Destination NPI |
Set this to ISDN/E.164. 0x00 is also acceptable. OpenMarket recommends 0x01. Value: 0x01 (hex) |
Destination Address |
Format the Destination Address of the recipient using the international E.164 format; e.g., <country code> followed by the <national number>. If you use Destination TON 0x1, format the destination address as follows: <country code><national number>. For example: 12125550123 If you use Destination TON 0x0, format the destination address as follows with a leading plus sign: +<country code><national number>. For example: +12125550123 Value: maximum 20 digits (C Octet String) |
Registered Delivery |
To determine if a message was delivered to a device, you can request a message delivery receipt when you submit the message by setting registered_delivery to 1. Intermediate delivery receipts are not supported. |
Required parameters for a virtual mobile number
Parameter |
Description |
---|---|
Source TON |
Indicates the type of number (TON). Set to international. Value: 0x01 (hex) |
Source NPI |
Set the Source NPI (numbering plan indicator) to unknown. 0x01 is also acceptable. OpenMarket recommends 0x00 for unknown. Value: 0x00 (hex) |
Source Address |
Set Source Address to your assigned US VMN. Value: maximum 20 digits (C Octet String) |
Destination TON |
Set the type of number to international (0x01). Value: 0x01 (hex) |
Destination NPI |
Set this to ISDN/E.164. 0x00 is also acceptable. OpenMarket recommends 0x01. Value: 0x01 (hex) |
Destination Address |
Format the Destination Address of the recipient using the international E.164 format; e.g., <country code> followed by the <national number>. If you use Destination TON 0x1, format the destination address as follows: <country code><national number>. For example: 13135551212 If you use Destination TON 0x0, format the destination address as follows with a leading plus sign: +<country code><national number>. For example: +13135551212 Value: maximum 20 digits (C Octet String) |
Registered Delivery |
To determine if a message was delivered to a device, you can request a message delivery receipt when you submit the message by setting registered_delivery to 1. Intermediate delivery receipts are not supported. |
Required parameters for SMS-enabled toll-free and landline numbers
Parameter |
Description |
---|---|
Source TON |
Indicates the type of number (TON). Set to international. Value: 0x01 (hex) |
Source NPI |
Set the Source NPI (numbering plan indicator) to unknown. 0x01 is also acceptable. OpenMarket recommends 0x00 for unknown. Value: 0x00 (hex) |
Source Address |
Set Source Address to your assigned North American toll free or land line number. Value: maximum 20 digits (C Octet String) |
Destination TON |
Set the type of number to international (0x01). Value: 0x01 (hex) |
Destination NPI |
Set this to ISDN/E.164. 0x00 is also acceptable. OpenMarket recommends 0x01. Value: 0x01 (hex) |
Destination Address |
Format the Destination Address of the recipient using the international E.164 format; e.g., <country code> followed by the <national number>. If you use Destination TON 0x1, format the destination address as follows: <country code><national number>. For example: 13135551212 If you use Destination TON 0x0, format the destination address as follows with a leading plus sign: +<country code><national number>. For example: +13135551212 Value: maximum 20 digits (C Octet String) |
Registered Delivery |
To determine if a message was delivered to a device, you can request a message delivery receipt when you submit the message by setting registered_delivery to 1. Intermediate delivery receipts are not supported. |
India
When sending messages to India, you'll need to include two OpenMarket custom TLVs.
Set Charge type to 20.
Set Purpose to either transactional or promotional, to conform to the local regulations.
You can send transactional messages to end users at any time of day, and messages can be one-way or two-way. An example might be messages advising about delivery of ordered goods. You cannot use transactional messages for marketing or promotional material.
Use a six-character alphabetic source address (message originator) for your transactional MT messages. Make sure to contact either OpenMarket Support or your account manager with the source addresses you intend to use for your service so that we can provision them.
You can deliver promotional messages to end users between 9:00 a.m. and 9:00 p.m. India time. If you submit promotional messages to OpenMarket outside of this period, the messages will be queued to the next allowable time.
Use any six-character alphabetic MT source address. You do not need to notify OpenMarket about the source addresses for promotional messages. Mobile operators in India replace the MT source address you provide with a random six-digit source address before the MT is sent to the end user.
See OpenMarket TLV Parameters.
Required parameters
Parameter |
Description |
---|---|
Source TON |
The type of number (TON). For India this can only be: Alphanumeric (5). Values: 0x05 (hex) |
Source NPI |
Set the Source NPI (numbering plan indicator) to unknown; 0x01 is also acceptable; OpenMarket recommends 0x00 for unknown. Value: 0x00 (hex) |
Source Address |
Use a six-character alphanumeric source address. Your OpenMarket account manager can help you provision source addresses. Value: maximum 20 characters (C Octet String) |
Destination TON |
Set type of number set to international: 0x01. Value: 0x01 (hex) |
Destination NPI |
Set to ISDN/E.164; OpenMarket recommends 0x01. Value: 0x01 (hex) |
Destination Address |
Format the Destination Address of the end user using the international E.164 format; <country code> followed by the <national number>. Use country code 91 for India phone numbers. If you use Destination TON 0x1, format the destination address as follows: <country code><national number>. For example: 919000000210 Value: maximum 20 digits (C Octet String) |
Charge Type |
Use charge type 0x14 (20 decimal) to designate the MT as international rate. Value: 0x14 |
Purpose |
Use 0x8 for transactional and 0x9 for promotional. Value: 0x9, 0x8 |
short message |
Your transactional or promotional text message. You may include a provisioned VMN in the short message to which end users may reply. |