SMPP SMS Gateway
Description
SMS Gateway implementation that support sending short messages over an SMSC's SMPP v3.4 interface.
May be used by
Properties
Server With Port (
serverWithPort) Description
Host address with port of the SMPP SMS Gateway.
Attributes
String
Mandatory
Example
194.298.234.64:8080
Example
smpp3.infobip.com:8888
Example
smpp2.infobip.com:8887
Account Username (
accountUsername) Description
Username or System ID of the registered SMPP account.
Attributes
String
Mandatory
Account Password (
accountPassword) Description
Password of the SMPP account.
Attributes
String
Mandatory
Sensitive
Smpp Bind Type (
smppBindType) Description
How to bind to the SMPP Gateway.
SMPP supports:
SMPP supports:
- Transceiver: send and receive SMS
- Transmitter: send SMS
- Receiver: receive SMS
Attributes
Enum
Optional
Default value
TRANSCEIVER
Message Encoding Charset (
messageEncodingCharset) Description
The charset to encode messages. This parameter is specified by the SMSC Server and must correlate with the "Data Coding Scheme" below. Notice that some charsets use more bytes than others to encode (certain) characters and thus reduce the maximum size of the message.
Attributes
Enum
Optional
Default value
ISO_8859_1
Data Coding Scheme (
dataCodingScheme) Description
The DCS or Data Coding Scheme indicates to the SMSC Server how the binary message shall be interpreted. A value of 0x00 (the default) leaves the decision to the server. Unless it is configurable on the server, a more specific DCS should be chosen based on the charset above.
Attributes
Enum
Optional
Default value
DEFAULT
Max Number Of Sessions (
maxNumberOfSessions) Description
Maximum number of concurrent sessions to open with SMPP SMS Gateway. If this SMPP gateway is used in different modules (Adminapp, Loginapp, etc) please consider that you can not configure the maximum number of allowed sessions of your provider, as each module will get its own instance of this SMPP gateway. Keep in mind that in multi-instance setups (active-active or horizontally scaling cloud setups) with n instances, the number of connection pools is multiplied by n.
Attributes
Integer
Optional
Default value
1
Window Size (
windowSize) Description
The window size to use.
The number of unacknowledged requests is called a window; for the best performance both communicating sides must be configured with the same window size.
The number of unacknowledged requests is called a window; for the best performance both communicating sides must be configured with the same window size.
Attributes
Integer
Optional
Default value
1
Connection And Send Timeout (
connectionAndSendTimeout) Description
The connection timeout in milliseconds.
The time how long to wait while trying to connect to the SMPP provider.
The send timeout in milliseconds.
The time how long to wait for a response when sending an SMS.
The timeout value includes both waiting for a "window" slot, the time it takes to transmit the actual bytes on the socket, and for the remote endpoint to send a response back.
The time how long to wait while trying to connect to the SMPP provider.
The send timeout in milliseconds.
The time how long to wait for a response when sending an SMS.
The timeout value includes both waiting for a "window" slot, the time it takes to transmit the actual bytes on the socket, and for the remote endpoint to send a response back.
Attributes
Integer
Optional
Default value
10000
Source TON (
sourceTon) Description
The TON (type of number) value to use for the source number. If your provider doesn't need a specific one use the default value "Unknown" as this is supported by most of the providers.
Attributes
Enum
Optional
Default value
UNKNOWN
Source NPI (
sourceNpi) Description
The NPI (numbering plan identification) value to use for the source number. If your provider doesn't need a specific one use the default value "Unknown" as this is supported by most of the providers.
Attributes
Enum
Optional
Default value
UNKNOWN
Destination TON (
destTon) Description
The TON value to use for the destination number. If your provider doesn't need a specific one use the default value "Unknown" as this is supported by most of the providers.
Attributes
Enum
Optional
Default value
UNKNOWN
Destination NPI (
destNpi) Description
The NPI value to use for the destination number. If your provider doesn't need a specific one use the default value "Unknown" as this is supported by most of the providers.
Attributes
Enum
Optional
Default value
UNKNOWN
Flash Mode (
flashMode) Description
When sending a message as flash message (Message Class 0), there are multiple ways of marking the message as such.
- DCS code 0xF0: Use 0xF0 as DCS code (SMPP 3.4 default)
- DCS code 0x10: Use 0x10 as DCS code (legacy GSM mode supported by some providers)
- dest_addr_subunit code: Use the optional parameter 'dest_addr_subunit' (as suggested as the recommended way by SMPP 3.4 standard)
- Ignore Flash: In case flash doesn't work correctly or isn't able to display special characters, send flash messages as normal messages instead
Attributes
Enum
Optional
Default value
DCS_CODE_F0
Session Name (
sessionName) Description
The name of the session to the SMPP provider.
If you need to give them a specific name you can do this here. Otherwise just keep the default name.
If you need to give them a specific name you can do this here. Otherwise just keep the default name.
Attributes
String
Optional
Default value
IAM-SmppSmsGateway
Enable Debugging (
enableDebugging) Description
Enable debug logging of all communication. Please note that the logged communication may contain the account password, mobile numbers and tokens. Only enable this option while debugging connection problems.
Attributes
Boolean
Optional
Default value
false
Use SSL (
useSsl) Description
If set to true SSL will be used to communicate with the SMPP provider. If set to true make sure all other properties needed for SSL are set as well. These are the values for the key store and the trust store.
Attributes
Boolean
Optional
Default value
false
Trust Store Path (
trustStorePath) Description
The path of the JKS trust store. Mandatory property if SSL is turned on.
Attributes
File/Path
Optional
Trust Store Password (
trustStorePassword) Description
The password of the JKS trust store. Mandatory property if SSL is turned on.
Attributes
String
Optional
Sensitive
YAML Template (with default values)
type: SmppSmsGatewaySettings
id: SmppSmsGatewaySettings-xxxxxx
displayName:
comment:
properties:
accountPassword:
accountUsername:
connectionAndSendTimeout: 10000
dataCodingScheme: DEFAULT
destNpi: UNKNOWN
destTon: UNKNOWN
enableDebugging: false
flashMode: DCS_CODE_F0
maxNumberOfSessions: 1
messageEncodingCharset: ISO_8859_1
serverWithPort:
sessionName: IAM-SmppSmsGateway
smppBindType: TRANSCEIVER
sourceNpi: UNKNOWN
sourceTon: UNKNOWN
trustStorePassword:
trustStorePath:
useSsl: false
windowSize: 1