Configure SMS and Email

Overview

• Notification service can notify the user through SMS and email for there action on DIGIT as an acknowledgment that their action has been successfully completed.

• ex: actions like property create, TL create, etc.

• To send SMS we need the help of 2 services, one on which the user is taking action and the second SMS service.

• To send an email we need the help of 2 services, one on which the user is taking action and second email service.

Pre-requisites

Before you proceed with the configuration, make sure the following pre-requisites are met -

• Prior Knowledge of Spring boot.

• Prior Knowledge of Kafka.

• Prior Knowledge of localization service.

Key Functionalities

• For a specific action of the user, he/she will get a SMS and email as an acknowledgment.

• Users can get SMS and email based on the localization language.

Configuration Details

• If you want to take action for a specific action on that action the service has to listen to a particular topic so that each time any record comes to the topic consumer will know that action has been taken and can trigger a notification for it.

  • ex: if you want to trigger a notification for Property create then the property service’s NotificationConsumer class should listen to topic egov.pt.assessment.create.topic so that each time any record comes to the topic egov.pt.assessment.create.topic NotificationConsumer will know that Property creates action that has been taken and can trigger a notification for it.

• when any record comes into the topic first the service will fetch all the required data like user name, property id, mobile number, tenant id, etc from the record which we fetched from the topic.

• Then we will fetch the message contain from localization and the service replaces the placeholders with the actual data.

• Then put the record in SMS topic in which SMS service is listening.

• email service is also listening to the same topic which SMS service is listening.

Reference Docs

Doc Links