Sending Bulk SMS using Sprint Boot Batch

-

You must use Spring Boot Batch Jobs to send the bulk SMS's.  It's very flexible to schedule these jobs using Cron expression, so you can send the SMS as per the requirement. e.g. daily, weekly or at a particular time. 


We need to integrate our job with the SMS provider like - msg91

Following is the Job configuration - This class has reader which will read the data for SMS content and job defination


@Configuration
@EnableBatchProcessing
public class SmsBatchConfiguration {
	
	@Autowired
	@Qualifier("smsContentReader")
    
	public ItemReader> itemReader;
	
	@Autowired
	@Qualifier("nenewalNotificationSMSProcessor")
	RenewalNotificationSMSProcessor renewalNotificationSMSProcessor;
	
	@Autowired
	@Qualifier("smsSender")
	SmsSender SmsSender;
	
	@Autowired
	public JobBuilderFactory jobBuilderFactory;
	
	@Autowired
	public StepBuilderFactory stepBuilderFactory;
	
	@Value("${renewal.batch.notifications.email}")
	private String email;
	
	@Bean
    public JobExecutionListener listener1() {
        return new JobCompletionNotificationListener(email, "SMS_JOB");
    }
	
	@Bean("smsReminderJob")
    public Job renewalSMSNotificationJob() {
		return jobBuilderFactory.get("renewalSMSNotificationJob")
                .incrementer(new RunIdIncrementer())
                .start(getSmsRenewalPolicyData())
				.listener(listener1())
                .build();
    }

    @Bean
    public Step getSmsRenewalPolicyData() {
        return stepBuilderFactory.get("renewal-policy-sms-n")
                ., SmsFlowModel>chunk(1)
                .reader(itemReader)
                .processor(renewalNotificationSMSProcessor)
                .writer(SmsSender)
                .build();
    }
    
}

Following class is the item processor which will get the data from reader and pass it to writter 


@StepScope
@Component("nenewalNotificationSMSProcessor")
public class RenewalNotificationSMSProcessor implements ItemProcessor, SmsFlowModel> {

    private static final Logger log = LoggerFactory.getLogger(RenewalNotificationSMSProcessor.class);

    @Value("${renewal.batch.notifications.sms.template_id}")
    private String template_id;

    @Value("${renewal.batch.notifications.sms.sender}")
    private String sender;

    @Override
    public SmsFlowModel process(List renewals) throws Exception {
        log.info("started - processing renewal policy details - SMS");
        List recipientsList = null;
        SmsFlowModel smsFlowModel = null;

        if (renewals != null && !renewals.isEmpty()) {
            recipientsList = new ArrayList<>();
            for (Renewal renewal : renewals) {
                if (renewal.getContactNumber() != null) {   // You will get the mobile number of recipient
                    MessageParameters msgParam = new MessageParameters();
                    msgParam.setPolicyno(renewal.getPolicyNo());
                    msgParam.setPremiumamount(String.valueOf(renewal.getPremium()));
                    msgParam.setMobiles("91".concat(renewal.getContactNumber().trim()));
                    recipientsList.add(msgParam);
                }
            }
            if (!recipientsList.isEmpty()) {
                smsFlowModel = new SmsFlowModel();
                smsFlowModel.setTemplate_id(this.template_id);
                smsFlowModel.setSender(this.sender);
                smsFlowModel.getRecipients().addAll(recipientsList);
            }
            return smsFlowModel;
        }
        return null;
    }

}

Following class will send the SMS, will are invoking the msg91 api to send the SMS to mobile numbers 


@StepScope
@Component("smsSender")
public class SmsSender implements ItemWriter {
    private static final Logger LOGGER = LoggerFactory.getLogger(SmsSender.class);

    @Value("${renewal.batch.notifications.sms.auth}")
    private String authKey;

    @Value("${renewal.batch.notifications.sms.url}")
    private String apiUrl;

    @Override
    public void write(List bulkSMS) throws Exception {
        LOGGER.info("about to start sending SMS---");
        StringBuilder msg = (StringBuilder) CommonConstant.getDaysMap().get("sms-job-message");

        if (bulkSMS != null && bulkSMS.size() > 0) {
            SmsFlowModel sms = bulkSMS.get(0);
            ObjectMapper mapper = new ObjectMapper();
            String jsonString = mapper.writeValueAsString(sms);
            msg.append("\n").append("SMS request json : ").append(jsonString);

			HttpResponse response = null;

            try {
                response = Unirest.post(apiUrl)
                        .header("authkey", authKey)
                        .header("content-type", "application/json")
                        .body(jsonString)
                        .asJson();
            } catch (UnirestException e) {
                LOGGER.error("Error occured while sending sms : {}", e.getMessage());
                e.printStackTrace();
            }

			msg.append("\n").append("------------------------------------------------------------------------------------");
			if (response != null) {
                JSONObject myObj = response.getBody().getObject();
                LOGGER.info("SMS server response : " + myObj);
                msg.append("\n").append("SMS server response : ").append(myObj);
            } else {
                LOGGER.info("SMS server response response is null");
                msg.append("\n").append("SMS server response response is null");
            }

        } else {
            LOGGER.info("--sms sender object is null ---");
            msg.append("\n").append("sms sender object is null");
        }
        CommonConstant.getDaysMap().put("sms-job-message", msg);
    }
}

Properties file

This job will send the SMS on daily basis at 12 PM (as per the cron expression value)



##Batch properties##
spring.profiles.active=prod
spring.batch.job.enabled=false
spring.first.initialization=false

##Database##
spring.datasource.url=jdbc:mysql://localhost:3306/test_db
spring.datasource.username=uname
spring.datasource.password=passwd
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.initialization-mode=ALWAYS
spring.datasource.continue-on-error=false
spring.jpa.database-platform=org.hibernate.dialect.MySQL5InnoDBDialect

spring.jpa.properties.hibernate.format_sql=false
spring.jpa.hibernate.ddl-auto=none
spring.jpa.show-sql=false

#sms-server
renewal.batch.notifications.sms.auth=
renewal.batch.notifications.sms.url=http://api.msg91.com/api/v5/flow/?response=json
renewal.batch.notifications.sms.template_id=
renewal.batch.notifications.sms.sender=SHRI

#cron-expression
sms.job.launch.cronExpression=0 0 12 * * *

POM file link https://github.com/shrikantar/bulksms/blob/main/pom.xml

Comments

Post a Comment

Popular posts from this blog

Right way to close HttpsURLConnetion using try with resources in java 8

-
HttpsURLConnection does not implement the AutoCloseable interface in Java 8 or later versions. Since HttpsURLConnection does not implement AutoCloseable, you cannot use it directly in a try-with-resources block. However, you can create a wrapper class that implements AutoCloseable and encapsulates the HttpsURLConnection object, and then use the wrapper class in a try-with-resources block. Here's an example of how to create a wrapper class for HttpsURLConnection that implements AutoCloseable: public class HttpsURLConnectionWrapper implements AutoCloseable { private final HttpsURLConnection connection; public HttpsURLConnectionWrapper(URL url) throws IOException { connection = (HttpsURLConnection) url.openConnection(); } public HttpsURLConnection getConnection() { return connection; } @Override public void close() throws IOException { connection.disconnect(); } } In this example, the HttpsURLConnectionWrapper c...
Read more

Spring Boot Batch - Parallel Processing (Running Multiple Jobs Concurrently)

-
Image
If you are new to Spring batch please check the earlier post about S pring batch introduction In this post we will see Spring boot batch example, Spring boot batch parallel processing example Spring boot batch parallel processing allows multiple batch jobs to run in parallel to minimize the total elapsed batch processing time. This is not a problem as long as the jobs are not sharing the same files, db-tables, or index spaces. If they do, this service should be implemented using partitioned data. We will create the application having the following 2 jobs -  1st Job: Reads the P roduct information from the database and after processing will give the rating to the project. 2nd Job: Reads the Invoice the information the database and update back to the database.  We are not focusing on the business logic here but the processing of data using multiple jobs. Technical Details -  Java 8 Spring Boot 2.x Spring Batch 4.x MySql 5...
Read more

Git Quick Card

-
Image
Git – Introduction There are many popular DVCS systems like Git, Mercurial, Bazaar which has grown maturely to implement distributed revision across their products. Git is widely used by the development teams across the world due to its simplicity, active open source the development team  and frequent releases/patches. Before moving forward with the git concepts, few of them terminologies which will be frequently used in this tutorial are defined below : Remote Repository : This refers to the specific project space on the central server where the project source code is stored and will be used by the team members for checkout or commit. Local Repository (.git directory): There is a local folder “.git” which is automatically created when the project or folder is git tracked. The “.git” folder is like a local database which will contain all information related to branches, commit history, user configurations, and metadata. Branches / Tags – Has the same definition as ...
Read more