Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 Following are the properties in application.properties file in notifcation sms service which are configurable.

Property

Value

Remarks

kafka.topics.notification.sms.name


egov.core.notification.sms

It is the topic name to which the notification sms consumer would subscribe. Any module wanting to integrate with this consumer should post data to this topic only.

sms.

gateway

provider.

to.useSMS_COUNTRY

class


Generic

This property decides which SMS

gateway

provider is to be used by the service to send messages. Currently, Console, MSDG and

SMS Country gateways

Generic have been implemented.

sms.provider.contentType

application/x-www-form-urlencoded

To configure form data or json api set sms

.enabled

true

Property to enable and disable SMS sending. It is a boolean field.

.provider.contentType=application/x-www-form-urlencoded or sms.provider.contentType=application/json respectively

sms.provider.requestType

POST

Property to configure the http method used to call provider

sms.provider.url


http://abc.in

URL of the provider. This will be given by the SMS provider only.

sms.

sender

provider.username

egovsms

Username as provided by the

gateway

provider which is passed during the API call to the

gateway

provider

sms.

sender

provider.password


abc123

Password as provided by the

gateway

provider which is passed during the API call to the

gateway

provider. This has to be encrypted and stored

sms.

sender

senderid


EGOV

SMS sender id provided by the

gateway

provider, this will show up as the sender on receiver’s phone

.

sms.sender.secure.key

asdfghjuytrewqsdfgh

Secure key to be passed during the API call to the gateway

.

This is optional, right now only MSDG expects a secure key, SMS Country doesn’t. So this is dependent on the provider.

sms.config.map

{'

User

uname':'$username', '

passwd

pwd': '$password', 'sid':'$senderid', '

mobilenumber

mobileno':'$mobileno', '

message

content':'$message', '

mtype

smsservicetype':'

N

unicodemsg', '

DR

myParam': '

Y

$extraParam' , '

smsservicetype

messageType': '

singlemsg

$mtype'}

Map of parameters to be passed to the API

gateway

provider. This is provider-specific.

The one attached here is for SMS Country, Please refer application.properties for other gateways.

$username maps to sms.provider.username

$password maps to sms.provider.password

$senderid maps to sms.senderid

$mobileno maps to mobileNumber from kafka fetched message

$message maps to the message from the kafka fetched message

$<name> any variable that is not from above list, is first checked in sms.category.map and then in application.properties and then in environment variable with full upper case and _ replacing -, space or

sms.category.map

{'mtype': {'*': 'abc', 'OTP': 'def'}}

replace any value in sms.config.map

sms.blacklist.numbers

5*,9999999999,88888888XX

For blacklisting, a “,” separated list of numbers or number patterns. To use patterns use X for any digit match and * for any number of digits match

sms.whitelist.numbers

5*,9999999999,88888888XX

For whitelisting, a “,” separated list of numbers or number patterns. To use patterns use X for any digit match and * for any number of digits match

sms.mobile.prefix

91

add the prefix to the mobile number coming in the message queue

Entities:

SMS: Model to capture the sms information. The object pushed onto the queue must be in accordance to this model. Contains mobileNumber and message.

...