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:

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.

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 might also want to set the custom TLV operator ID for short code messaging. Do not include a operator 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 operator ID it will be ignored. You may include a operator ID when submitting MTs from toll free numbers.

Required parameters for a short code

Parameter

Description

Source TON

Set to a network-specific value.


Size (octets):1

Type: Integer

Value: 0x03

Source NPI

Set to 0x00, unknown.


Size (octets):1

Type: Integer

Value: 0x00

Source Address

Set Source Address to your assigned short code.


Size (octets): Minimum: 1, maximum: 21

Type: C-Octet String

Value: maximum 20 digits

Destination TON

Set the type of number to international, 0x01.


Size (octets): 1

Type: Integer

Value: 0x01

Destination NPI

Set this to international: 0x01.


Size (octets): 1

Type: Integer

Value: 0x01

Destination Address

Format the Destination Address of the recipient using the international E.164 format: <country code><national number>. Do not include the "+" (plus) sign before the number. For example: 

12125550123

Size (octets): Variable, but a maximum of 21

Type: C-Octet String

Value: maximum 20 digits

Registered Delivery

Request a message delivery receipt when you submit the message by setting this parameter to 0x01; otherwise, set this to 0x00 to indicate that no final delivery receipt is required. Intermediate delivery receipts are not supported.


Size (octets): 1

Type: Integer

Value: 0x00 or 0x01

Required parameters for a virtual mobile number

Parameter

Description

Source TON

Set to international, 0x01.


Size (octets):1

Type: Integer

Value: 0x01

Source NPI

This will always be 0x00, unknown.


Size (octets):1

Type: Integer

Value: 0x00

Source Address

Set Source Address to your assigned US VMN.


Size (octets): Minimum: 1, maximum: 21

Type: C-Octet String

Value: maximum 20 digits

Destination TON

Set the type of number to international, 0x01.


Size (octets): 1

Type: Integer

Value: 0x01

Destination NPI

Set this to international, 0x01.


Size (octets): 1

Type: Integer

Value: 0x01

Destination Address

Format the Destination Address of the recipient using the international E.164 format: <country code><national number>. Do not include the "+" (plus) sign before the number. For example: 

13135551212

Size (octets): Variable, but a maximum of 201.

Type: C-Octet String

Value: maximum 20 digits

Registered Delivery

Request a message delivery receipt when you submit the message by setting this parameter to 0x01; otherwise, set this to 0x00 to indicate that no final delivery receipt is required. Intermediate delivery receipts are not supported.


Size (octets): 1

Type: Integer

Value: 0x00 or 0x01

Required parameters for SMS-enabled toll-free and landline numbers

Parameter

Description

Source TON

Set to international, 0x01.


Size (octets):1

Type: Integer

Value: 0x01

Source NPI

Set this to 0x00, unknown.


Size (octets):1

Type: Integer

Value: 0x00

Source Address

Set Source Address to your assigned North American toll free or land line number.


Size (octets): Minimum: 1, maximum: 21

Type: C-Octet String

Value: maximum 20 digits

Destination TON

Set to international, 0x01.


Size (octets): 1

Type: Integer

Value: 0x01

Destination NPI

Set this to international, 0x01.


Size (octets): 1

Type: Integer

Value: 0x01

Destination Address

Format the Destination Address of the recipient using the international E.164 format: <country code><national number>. For example: 

13135551212

Size (octets): Variable, but a maximum of 21

Type: C-Octet String

Value: maximum 20 digits (C Octet String)

Registered Delivery

Request a message delivery receipt when you submit the message by setting this parameter to 0x01; otherwise, set this to 0x00 to indicate that no final delivery receipt is required. Intermediate delivery receipts are not supported.


Size (octets): 1

Type: Integer

Value: 0x00 or 0x01

India

There are two types of SMS messages in India: transactional or promotional. By default, MT messages are classified as transactional, meaning that one- or two-way messages can be sent to end users at any time of day. For example, a transactional message could be sent advising about the delivery of ordered goods. However, you cannot use transactional messages for marketing or promotional material.

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 Send a Mobile Terminated (MT) message for more information about MT parameters.

Required parameters for SMS messages to India

Parameter

Description

Source TON

The type of number (TON). For India this can only be alphanumeric (0x05).


Size (octets):1

Type: Integer

Values:0x05

Source NPI

Set to 0x00,unknown.


Size (octets):1

Type: Integer

Value: 0x00

Source Address

Use a six-character alphanumeric source address.


Your OpenMarket account manager can help you provision source addresses.

Size (octets): Minimum: 1, maximum: 21

Type: C-Octet String

Value: maximum 20 characters

Destination TON

Set to international, 0x01.


Size (octets): 1

Type: Integer

Value: 0x01

Destination NPI

Set to international, 0x01.


Size (octets): 1

Type: Integer

Value: 0x01

Destination Address

Format the Destination Address of the end user using the international E.164 format: <country code> <national number>. Use country code 91 for India phone numbers. For example: 

919000000210

Size (octets): Variable, but a maximum of 21

Type: C-Octet String

Value: maximum 20 digits

short message

Your text message. You may include a provisioned VMN in the short message to which end users may reply.


Size (octets): Variable, 0 - 160

Type: Octet String

Value: The message content. If the Short Message is greater than the Short Message Length, it is truncated to the value set by the Short Message Length

International

Required parameters for international numbers (rest of world)

Parameter

Description

Source TON

The type of number (TON). Set this to either:

  • International format phone number (0x01)
  • Alphanumeric (0x05)
  • Short code (0x03)

Size (octets):1

Type: Integer

Values: 0x01, 0x03, or 0x0 5

Source NPI

This should be set to 0x00, unknown.


Size (octets):1

Type: Integer

Value: 0x00

Source Address

Use an alphanumeric source address or format the using the international E.164 format: <country code> followed by the <national number>.

 

Size (octets): Minimum: 1, maximum: 21

Type: C-Octet String

Values:

  • Alphanumeric characters with source TON 0x05. The maximum length is 11 digits/characters (C Octet String).

  • Short code with source TON 0x03. The maximum length is 20 digits/characters (C Octet String).
  • International format phone number with source TON 0x01. The maximum length is 20 digits/characters (C Octet String).

Destination TON

Set type of number set to international, 0x01.


Size (octets): 1

Type: Integer

Value: 0x01

Destination NPI

Set to international, 0x01.


Size (octets): 1

Type: Integer

Value: 0x01

Destination Address

Format the Destination Address of the recipient using the international E.164 format: <country code><national number>. Do not include the "+" (plus) sign before the number. For example: 

442081234567

Size (octets): Variable, but a maximum of 21

Type: C-Octet String

Value: maximum 20 digits

Registered Delivery

Request a message delivery receipt when you submit the message by setting this parameter to 0x01; otherwise, set this to 0x00 to indicate that no final delivery receipt is required. Intermediate delivery receipts are not supported.


Size (octets): 1

Type: Integer

Value: 0x00 or 0x01