SMPP SMS sender

application/pom.xml

@@ -249,6 +249,10 @@
             <groupId>io.grpc</groupId>
             <artifactId>grpc-stub</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.opensmpp</groupId>
+            <artifactId>opensmpp-core</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.thingsboard</groupId>
             <artifactId>springfox-boot-starter</artifactId>

application/src/main/java/org/thingsboard/server/service/sms/DefaultSmsSenderFactory.java

@@ -19,9 +19,11 @@ import org.springframework.stereotype.Component;
 import org.thingsboard.rule.engine.api.sms.SmsSender;
 import org.thingsboard.rule.engine.api.sms.SmsSenderFactory;
 import org.thingsboard.server.common.data.sms.config.AwsSnsSmsProviderConfiguration;
+import org.thingsboard.server.common.data.sms.config.SmppSmsProviderConfiguration;
 import org.thingsboard.server.common.data.sms.config.SmsProviderConfiguration;
 import org.thingsboard.server.common.data.sms.config.TwilioSmsProviderConfiguration;
 import org.thingsboard.server.service.sms.aws.AwsSmsSender;
+import org.thingsboard.server.service.sms.smpp.SmppSmsSender;
 import org.thingsboard.server.service.sms.twilio.TwilioSmsSender;
 
 @Component
@@ -34,6 +36,8 @@ public class DefaultSmsSenderFactory implements SmsSenderFactory {
                 return new AwsSmsSender((AwsSnsSmsProviderConfiguration)config);
             case TWILIO:
                 return new TwilioSmsSender((TwilioSmsProviderConfiguration)config);
+            case SMPP:
+                return new SmppSmsSender((SmppSmsProviderConfiguration) config);
             default:
                 throw new RuntimeException("Unknown SMS provider type " + config.getType());
         }

application/src/main/java/org/thingsboard/server/service/sms/smpp/SmppSmsSender.java

@@ -0,0 +1,154 @@
+package org.thingsboard.server.service.sms.smpp;
+
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.exception.ExceptionUtils;
+import org.smpp.Connection;
+import org.smpp.Data;
+import org.smpp.Session;
+import org.smpp.TCPIPConnection;
+import org.smpp.TimeoutException;
+import org.smpp.WrongSessionStateException;
+import org.smpp.pdu.Address;
+import org.smpp.pdu.BindReceiver;
+import org.smpp.pdu.BindRequest;
+import org.smpp.pdu.BindResponse;
+import org.smpp.pdu.BindTransciever;
+import org.smpp.pdu.BindTransmitter;
+import org.smpp.pdu.PDUException;
+import org.smpp.pdu.SubmitSM;
+import org.smpp.pdu.SubmitSMResp;
+import org.thingsboard.rule.engine.api.sms.exception.SmsException;
+import org.thingsboard.server.common.data.sms.config.SmppSmsProviderConfiguration;
+import org.thingsboard.server.service.sms.AbstractSmsSender;
+
+import java.io.IOException;
+import java.util.Optional;
+
+@Slf4j
+public class SmppSmsSender extends AbstractSmsSender {
+    private final SmppSmsProviderConfiguration config;
+
+    private Session smppSession;
+
+    public SmppSmsSender(SmppSmsProviderConfiguration config) {
+        this.config = config;
+    }
+
+    @Override
+    public int sendSms(String numberTo, String message) throws SmsException {
+        try {
+            checkSmppSession();
+
+            SubmitSM request = new SubmitSM();
+            if (StringUtils.isNotEmpty(config.getServiceType())) {
+                request.setServiceType(config.getServiceType());
+            }
+            if (StringUtils.isNotEmpty(config.getSourceAddress())) {
+                request.setSourceAddr(new Address(config.getTon(), config.getNpi(), config.getSourceAddress()));
+            }
+            numberTo = prepareNumber(numberTo);
+            request.setDestAddr(new Address(config.getDestinationTon(), config.getDestinationNpi(), numberTo));
+            request.setShortMessage(message);
+            request.setDataCoding(Optional.ofNullable(config.getCodingScheme()).orElse((byte) 0));
+            request.setReplaceIfPresentFlag((byte) 0);
+            request.setEsmClass((byte) 0);
+            request.setProtocolId((byte) 0);
+            request.setPriorityFlag((byte) 0);
+            request.setRegisteredDelivery((byte) 0);
+            request.setSmDefaultMsgId((byte) 0);
+
+            SubmitSMResp response = smppSession.submit(request);
+
+            log.info("SMPP submit command status: {}", response.getCommandStatus());
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+
+        return countMessageSegments(message);
+    }
+
+    public synchronized void checkSmppSession() {
+        if (smppSession == null || !smppSession.isOpened()) {
+            smppSession = initSmppSession();
+        }
+    }
+
+    private Session initSmppSession() {
+        try {
+            Connection connection = new TCPIPConnection(config.getHost(), config.getPort());
+            Session session = new Session(connection);
+
+            BindRequest bindRequest;
+            if (config.getBindType() == null) {
+                bindRequest = new BindTransmitter();
+            } else {
+                switch (config.getBindType()) {
+                    case TX:
+                        bindRequest =  new BindTransmitter();
+                        break;
+                    case RX:
+                        bindRequest = new BindReceiver();
+                        break;
+                    case TRX:
+                        bindRequest = new BindTransciever();
+                        break;
+                    default:
+                        throw new UnsupportedOperationException("Unsupported bind type " + config.getBindType());
+                }
+            }
+
+            bindRequest.setSystemId(config.getSystemId());
+            bindRequest.setPassword(config.getPassword());
+
+            byte interfaceVersion;
+            switch (config.getProtocolVersion()) {
+                case "3.3":
+                    interfaceVersion = Data.SMPP_V33;
+                    break;
+                case "3.4":
+                    interfaceVersion = Data.SMPP_V34;
+                    break;
+                default:
+                    throw new UnsupportedOperationException("Unsupported SMPP version: " + config.getProtocolVersion());
+            }
+            bindRequest.setInterfaceVersion(interfaceVersion);
+
+            if (StringUtils.isNotEmpty(config.getSystemType())) {
+                bindRequest.setSystemType(config.getSystemType());
+            }
+            if (StringUtils.isNotEmpty(config.getAddressRange())) {
+                bindRequest.setAddressRange(config.getDestinationTon(), config.getDestinationNpi(), config.getAddressRange());
+            }
+
+            BindResponse bindResponse = session.bind(bindRequest);
+            log.debug("SMPP bind response: {}", bindResponse.debugString());
+
+            if (bindResponse.getCommandStatus() != 0) {
+                throw new IllegalStateException("Error status when binding: " + bindResponse.getCommandStatus());
+            }
+
+            return session;
+        } catch (Exception e) {
+            throw new IllegalArgumentException("Failed to establish SMPP session: " + ExceptionUtils.getRootCauseMessage(e));
+        }
+    }
+
+    private String prepareNumber(String number) {
+        if (config.getDestinationTon() == Data.GSM_TON_INTERNATIONAL) {
+            return StringUtils.removeStart(number, "+");
+        }
+        return number;
+    }
+
+    @Override
+    public void destroy() {
+        try {
+            smppSession.unbind();
+            smppSession.close();
+        } catch (TimeoutException | PDUException | IOException | WrongSessionStateException e) {
+            throw new RuntimeException(e);
+        }
+
+    }
+}

common/data/src/main/java/org/thingsboard/server/common/data/sms/config/SmppSmsProviderConfiguration.java

@@ -0,0 +1,63 @@
+package org.thingsboard.server.common.data.sms.config;
+
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
+
+@Data
+public class SmppSmsProviderConfiguration implements SmsProviderConfiguration {
+    @ApiModelProperty(allowableValues = "3.3, 3.4")
+    private String protocolVersion;
+
+    private String host;
+    private Integer port;
+
+    private String systemId;
+    private String password;
+
+    @ApiModelProperty(required = false)
+    private String systemType;
+    @ApiModelProperty(value = "TX - Transmitter, RX - Receiver, TRX - Transciever. By default TX is used", required = false)
+    private SmppBindType bindType;
+    @ApiModelProperty(required = false)
+    private String serviceType;
+
+    @ApiModelProperty(required = false)
+    private Byte ton;
+    @ApiModelProperty(required = false)
+    private Byte npi;
+    @ApiModelProperty(required = false)
+    private String sourceAddress;
+
+    @ApiModelProperty(required = false)
+    private Byte destinationTon;
+    @ApiModelProperty(required = false)
+    private Byte destinationNpi;
+    @ApiModelProperty(required = false)
+    private String addressRange;
+
+    @ApiModelProperty(allowableValues = "0-10,13-14",
+            value = "0 - SMSC Default Alphabet (ASCII for short and long code and to GSM for toll-free, used as default)\n" +
+                    "1 - IA5 (ASCII for short and long code, Latin 9 for toll-free (ISO-8859-9))\n" +
+                    "2 - Octet Unspecified (8-bit binary)\n" +
+                    "3 - Latin 1 (ISO-8859-1)\n" +
+                    "4 - Octet Unspecified (8-bit binary)\n" +
+                    "5 - JIS (X 0208-1990)\n" +
+                    "6 - Cyrillic (ISO-8859-5)\n" +
+                    "7 - Latin/Hebrew (ISO-8859-8)\n" +
+                    "8 - UCS2/UTF-16 (ISO/IEC-10646)\n" +
+                    "9 - Pictogram Encoding\n" +
+                    "10 - Music Codes (ISO-2022-JP)\n" +
+                    "13 - Extended Kanji JIS (X 0212-1990)\n" +
+                    "14 - Korean Graphic Character Set (KS C 5601/KS X 1001)", required = false)
+    private Byte codingScheme;
+
+    @Override
+    public SmsProviderType getType() {
+        return SmsProviderType.SMPP;
+    }
+
+    public enum SmppBindType {
+        TX, RX, TRX
+    }
+
+}

common/data/src/main/java/org/thingsboard/server/common/data/sms/config/SmsProviderConfiguration.java

@@ -27,7 +27,9 @@ import com.fasterxml.jackson.annotation.JsonTypeInfo;
         property = "type")
 @JsonSubTypes({
         @JsonSubTypes.Type(value = AwsSnsSmsProviderConfiguration.class, name = "AWS_SNS"),
-        @JsonSubTypes.Type(value = TwilioSmsProviderConfiguration.class, name = "TWILIO")})
+        @JsonSubTypes.Type(value = TwilioSmsProviderConfiguration.class, name = "TWILIO"),
+        @JsonSubTypes.Type(value = SmppSmsProviderConfiguration.class, name = "SMPP")
+})
 public interface SmsProviderConfiguration {
 
     @JsonIgnore

common/data/src/main/java/org/thingsboard/server/common/data/sms/config/SmsProviderType.java

@@ -17,5 +17,6 @@ package org.thingsboard.server.common.data.sms.config;
 
 public enum SmsProviderType {
     AWS_SNS,
-    TWILIO
+    TWILIO,
+    SMPP
 }

pom.xml

@@ -130,6 +130,7 @@
         <!--      BLACKBOX TEST SCOPE     -->
         <testcontainers.version>1.16.0</testcontainers.version>
         <zeroturnaround.version>1.12</zeroturnaround.version>
+        <opensmpp.version>3.0.0</opensmpp.version>
     </properties>
 
     <modules>
@@ -1872,6 +1873,11 @@
                 <version>${zeroturnaround.version}</version>
                 <scope>test</scope>
             </dependency>
+            <dependency>
+                <groupId>org.opensmpp</groupId>
+                <artifactId>opensmpp-core</artifactId>
+                <version>${opensmpp.version}</version>
+            </dependency>
         </dependencies>
     </dependencyManagement>