SMS & Email

Steps to configure SMS & Email

Overview

This guide explains how to enable and configure Email and SMS notifications for CCRS.

SMS Service

The notification service is a means of communicating important information and updates to users regarding their various transactions on the CCRS application. To enable this, there are specific notification parameters that are system-configured for different steps in the application workflow. These configurations can be modified or reconfigured as per the State Implementation requirements.

egov-notification-sms and egov-notification-mail services are responsible for notifying users through SMS and email, respectively.

  • SMS templates are stored as localisation messages in both English and the local language.

  • These templates use placeholders, which the service replaces with actual data at runtime.

  • The end user can add or modify localisation messages based on their specific requirements.

Email Service

  • egov-notification-mail listens to the egov.core.notification.email Kafka topic.

  • It reads the message and sends email notifications using the SMTP protocol.

  • Once the email content is generated, it is localised via the egov-localisation service before being sent.

Steps

1

Enable notifications in the environment.yaml

  • Configure the SMS provider details in the env.yaml file: env.yaml (Line 75)

  • The sms-provider-url is configured for sms country. Based on your sms provider, change the configurations below:

sms-provider-url: "http://api.smscountry.com/SMSCwebservice_bulk.aspx"
  sms.provider.url: "http://api.smscountry.com/SMSCwebservice_bulk.aspx"
  sms.provider.class: "Generic"
  sms.provider.contentType:  "application/x-www-form-urlencoded"
  sms-config-map: "{'User':'$username', 'passwd': '$password', 'sid':'$senderid', 'mobilenumber':'$mobileno', 'message':'$message', 'mtype':'N', 'DR':'N', 'smsservicetype':'singlemsg'}"
  sms-gateway-to-use: "SMS_COUNTRY"
  sms-sender: "SMSCOUNTRY"
  sms-sender-requesttype: "GET"
  sms-custom-config: "true"
  sms-extra-req-params: "mtype=N&DR=Y"
  sms-sender-req-param-name: "sid"
  sms-sender-username-req-param-name: "User"
  sms-sender-password-req-param-name: "passwd"
  sms-destination-mobile-req-param-name: "mobilenumber"
  sms-message-req-param-name: "message"
  sms-error-codes: "401,403,404,405,406,407,408,409,410,411,412,413,414"

Note: The user must purchase an SMS package and configure the provider credentials in the system accordingly.The integration URL and required parameters to configure in env.yaml.

The current SMS templates configured for PGR can be accessed at the following link:

📄 PGR SMS Configurations

2

Enable Email Service

  • By default, Gmail SMTP is configured.

  • To send and receive emails from the server, please verify the POP and IMAP account settings at the server level.

3

Enable IMAP and POP access

  • Go to: https://mail.google.com/

  • Click Settings (⚙️) → See all settings

  • Navigate to the "Forwarding and POP/IMAP" tab

  • Enable:

    • IMAP Access: Enable IMAP

    • (Optional) POP Access: Enable POP for all mail

  • Click Save Changes.

4

Update SMS Credentials

5

Testing Notifications

After setup:

  • Perform a workflow action in the application (like raising a complaint)

  • Ensure the expected user (citizen or employee) receives:

    • SMS

    • Email (if configured)

Check the logs in egov-user-event and notification services to debug.

PreviousService Level Agreement (SLA)NextWorkflow

Last updated

Was this helpful?