smpp_gateway SMPP gateway

<< Click to Display Table of Contents >>

Navigation:  Reference > Gateway properties >

smpp_gateway SMPP gateway

Only available in Diafaan SMS Server - basic and full editions.

 

SMPP server properties


Host or IP number

The host name or IP number of the SMPP server.

 

Server port

The port number of the SMPP server. Port number 2775 is the default port for the SMPP protocol but other port numbers are also common.

 

Use SSL/TLS

Check this option if the SMPP server requires an encrypted SSL or TLS connection.

 

SMPP version

Most SMPP servers support both version 3.3 and 3.4 of the SMPP protocol. Some advanced features of the protocol are only supported in version 3.4 but basic messaging is the same for both versions.

.

User name

The user name (or System ID) of your SMPP account.

 

Password

The password of your SMPP account.

 

Default source address

Some SMPP operators require that you send a source address or sender id with each message. The default source address will be used for each message where the user does not provide a source address.

 

Users can override the default source address

If you do not want users to send their own source addresses with the messages you can disable this option here. Some SMPP operators block messages with an unapproved source address, in the ApprovedSourceAddress property in the advanced settings you can provide a list with valid source addresses.

 

EditGateway_SMPP1

 

 

Advanced properties


LogCommunicationToFile

Log all internet communication to file. Use this option only if you encounter problems with the connection to your SMPP account. If enabled, the status windows of the SMPP gateway provides a link to the location on you hard disk where the file is stored.

 

MaximumBatchSize

The maximum number of messages this gateway will process in one batch. If this value is higher than one and a number of messages are sent at the same time, the gateway loads multiple messages concurrently. This increases the speed in which the messages are sent.

 

NumberTemplate

The number template can be used to translate the number from one format to another.

 

For more information see Use number templates.

 

SourceAddressTemplate

The number template can be used to translate the From field from one format to another.

 

For more information see Use number templates.

 

NumberWhiteList

List of allowed mobile numbers for received SMS messages, messages from other numbers are blocked. When the list does not have any items received SMS messages from all numbers are allowed.

 

For more information about the white list and black list format see: Use white lists and black lists.

 

QuietHours

A list of 24 hour numbers (separated with semicolons) when sending messages with this gateway is paused. The hour number can be appended with .1, .2, .3 or .4 to specify the first, second, third or fourth quarter of the hour. If the messages cannot be sent with another gateway, they stay in the send queue until the quiet hours are over and this gateway resumes message sending.

00;01;23 pauses message sending from 23:00:00 to 01:59:59.

12.1;12.2;18.1;18.2 pauses message sending from 12:00:00 to 12:29:59 and from 18:00:00 to 18:29:59.

 

EnableHTTPCallbacks

Enable or disable HTTP callbacks for this gateway. This option is only available when the HTTP callback option is enabled in the general options.

 

AddressRange

A parameter used when receiving messages. Set this field only if instructed to do so by your SMPP service provider.

 

AsyncModeWindowSize

If this property is set to a value higher than 1, the SMPP gateway does not wait for a response from the SMPP server before the next message is sent. This can increase message throughput considerably but if the AsyncModeWindowSize is set too high or if the SMPP server does not support asynchronous mode properly it can lead to overloading of the SMPP server.

 

BindNPI

The Number Plan Indicator parameter for the SMPP bind command, default is 0 (Unknown).

 

BindTON

The Type Of Number parameter for the SMPP bind command, default is 1 (International number).

 

CharacterSetReceive

The character set that the SMPP server uses for incoming text messages (not used for Unicode or data messages). Use ISO-8859-1 or ISO-8859-15 when the '@' character is not displayed properly.

 

CharacterSetReceiveMapping

Character set mapping for outgoing text messages. This field may contain a list of character number pairs in hexadecimal number format. The character pairs are separated by semicolons and the two character numbers are separated by a normal colon. E.g. '2A:2B;32:3F' maps number '0x2A' to character 2B ('+') and number '0x32' to character 3F ('?').

 

CharacterSetSend

The character set for outgoing text messages. Use IA5, ISO-8859-1 or ISO-8859-15 when the '@' character is not displayed properly.

 

CharacterSetSendDCS

The Data Coding Scheme (DCS) for outgoing text messages. Default value is 0 for the default character set, 3 for ISO-8859-1/ISO-8859-15.

 

CharacterSetSendMapping

Character set mapping for outgoing text messages. This field may contain a list of character number pairs in hexadecimal number format. The character pairs are separated by semicolons and the two character numbers are separated by a normal colon. E.g. '2A:2B;32:3F' maps character '2A' ('*') to 0x2B and character '32' ('2') to 0x3F.

 

IgnoreACCEPTDReceiptStatus

Ignore receipts with status ACCEPTED.

 

KeepAliveInterval

The SMPP Gateway sends an enquire_link message to the SMPP server after a period of inactivity to keep the connection to the SMPP server intact. If the SMPP server keeps breaking the connection after a certain time the timeout interval can be set here.

 

MaxMessagesPerMinute

This setting limits the amount of messages that the SMPP Gateway will send each minute. Some SMPP servers enforce a strict message throttling and sending more messages then are allowed might actually decrease message throughput.

 

MaxMessagesPerSecond

This setting limits the amount of messages that the SMPP Gateway will send each second, leave at 0 to disable this limit. This setting should only be used for SMPP servers that have a very strict throttling policy.

 

MessageIdFormat

Specify the message ID format that the SMPP server uses. Hexadecimal is the default option for SMPP 3.3, it translate the message ID from a hexadecimal value to a numeric value and assumes that the message ID in a receipt is a numeric value.

 

MessageOutHandling

This property specifies how the messages are sent to the SMPP server (only for SMPP versions 3.4 and 5.0). Submit_SM sends long messages in multiple message parts, this is the standard option for most SMPP servers. The Submit_SM_UsePayloadTlv and Data_SM settings send long messages in one SMPP packet using the SMPP 'Payload' TLV field.

 

PermanentErrorList

A list of GSM modem error codes (separated by semicolons) that are regarded as permanent errors. No more send attempts will be made for the message.

 

ReceiptTimestampOffset

Offset in (fractional) hours for the receipt time stamp. Use a positive number to increase, and a negative number to decrease the time.

 

SSLProtocols

List of negotiable SSL/TLS protocols for secure connections to the SMPP server.

 

SystemType

The system type is a text that the SMPP Gateway sends to the SMPP server to signal what sort of service it is. Some SMPP servers require a specific system type value.

 

TransceiverMode

By default, the SMPP Gateway starts up two connections to the SMPP server., one for sending messages and one for receiving messages. SMPP version 3.4 supports a transceiver mode where one connection is used for both sending and receiving messages.

 

UseMessageIdPrefix

Set to True if you want to attach the gateway ID to the message ID, leave this option to False if you use multiple SMPP gateway with the same user ID.

 

ValidityPeriod

The validity period of sent messages, specified as a relative date and time in the format YYMMDDhhmmss000R. E.g. 000003000000000R specifies a validity period of 3 days.

Leave empty for the default validity period of the SMPP server.

 

ApprovedSourceAddressList

SMPP supports both numeric and text source addresses. To prevent spoofing, some SMPP operators require that source addresses have to be approved before you can use them. the ApprovedSourceAddressList can contain a list of valid source addresses, if the source address is not in the list the default source address is used instead.

If the ApprovedSourceAddressList is empty all source addresses are valid.

 

DefaultAddressType

The address type (TON) that is used when no specific address type is detected. The detection of the address type is as follows:

If the address starts with a + it is regarded as an international phone number (TON 1 and NPI 1).

If characters are detected it is an alphanumeric source address (TON 5 and NPI 0)

If it has less than MaxShortCodeLength numbers it is a shortcode (TON 3 and NPI 1)

The default address type value is used with NPI 1.

 

DeliveryConfirmation

Require status updates for the SMS messages after it is sent to the SMSC. If you do not need to know if the SMS messages are delivered on the mobile phone you can disable status updates here.

 

MaxMessageParts

Messages to send that are longer than 160 characters or 70 characters for unicode messages can be split in multiple SMS messages that are recombined to one message on the handset of the receiver. The MaxMessagePart property limits the amount of partial messages that the gateway sends with a long message. If the message is longer than can be sent with the maximum message parts, the rest of the message is discarded.

 

MaxShortCodeLength

The maximum number length where the number is regarded as a short code, short codes are encoded as Network Specific numbers.

 

MessageInHandling

By default, partial received messages are combined to the original message length. Since delivery of some message parts might be delayed this could mean that the delivery of the whole message will be delayed. If, after a certain timeout, not all message parts are received, the partial messages are delivered individually. The messages can be forwarded in on of the the following ways:

 

CombineMessageParts

This is the default option, multipart message parts are combined to the original long message.

SingleMessageParts

The message parts are not combined but forwarded immediately as individual message parts.

Binary

The received messages are not decoded and combined but forwarded as message type sms.binary.smpp with the message field set to <DCS>,<PID>,<ESMCLASS>,<UDH>,<Data>.

SMPP_PDU

The received messages are forwarded as raw SMPP PDU packets.

 

MessageType

The message type is the default value for the SMS message encoding, the default value may be replaced with the message type specified by the sending Connector.

The gateway uses four possible value for the default message type:

 

Automatic

Standard Text encoding is the default, Unicode encoding will be used only if the message contains characters that are not in the default GSM SMS character set.

StandardText

The default 7-bit GSM SMS character set is used, all other characters are converted to question marks.

Unicode

All messages are sent in Unicode 16-bit encoding.

Data

All messages are sent in binary 8-bit encoding.

 

The SMPP gateway supports the following custom message types:

 

sms.automatic

Standard Text encoding is the default, Unicode encoding will be used only if the message contains characters that are not in the default GSM SMS character set.

sms.text

The default 7-bit GSM SMS character set is used, all other characters are converted to question marks.

sms.unicode

The message is sent in Unicode 16-bit encoding.

sms.binary

The message is sent in binary 8-bit encoding.

sms.automatic.flash

Flash SMS, standard Text encoding is the default, Unicode encoding will be used only if the message contains characters that are not in the default GSM SMS character set.

sms.text.flash

Flash SMS, the default 7-bit GSM SMS character set is used, all other characters are converted to question marks.

smpp.pdu

Raw SMPP PDU packet.

 

ReceiptHandling

This option changes the way SMPP receipts for previously sent messages are handled.

 

Default

Only set the Status Code, Status Text and, in case of an error, Error Code and readable Error Text.

WriteToErrorText

The same as Default, in case of error, write the full receipt to the Error Text .

HandleAsReceivedMessage

Handle the receipt as a received SMS message with message type smpp.receipt.

HandleAsReceivedMessageWithTLV

Handle the receipt as a received SMS message with message type smpp.xml.receipt and formatted as an XML message with all TLV parameters of the SMPP packet.

 

Use16BitConcatenationId

Use a 16 bit concatenation ID to send long concatenated SMS messages, the default concatenation ID for SMS is an 8-bit number.