> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/platform/build/core-services/localization-service/configuring-localization/configure-sms-and-email.md).

# Configure SMS and Email

### Overview <a href="#overview" id="overview"></a>

* Notification service can notify the user through SMS and email for there action on DIGIT as an acknowledgement 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 <a href="#pre-requisites" id="pre-requisites"></a>

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 <a href="#key-functionalities" id="key-functionalities"></a>

* 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 <a href="#configuration-details" id="configuration-details"></a>

* 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 <a href="#reference-docs" id="reference-docs"></a>

#### Doc Links <a href="#doc-links" id="doc-links"></a>

| Title                | Link                                                                                                                                            |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| NotificationConsumer | <https://github.com/egovernments/municipal-services/blob/master/property-services/src/main/java/org/egov/pt/consumer/NotificationConsumer.java> |
|                      |                                                                                                                                                 |

[![Creative Commons License](https://i.creativecommons.org/l/by/4.0/80x15.png)​](http://creativecommons.org/licenses/by/4.0/)All content on this page by [eGov Foundation](https://egov.org.in/) is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digit.org/platform/build/core-services/localization-service/configuring-localization/configure-sms-and-email.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
