https://github.com/thirunjuguna/mifos-sms-gateway

Mifos Sms Gateway
https://github.com/thirunjuguna/mifos-sms-gateway

Last synced: about 1 month ago
JSON representation

Mifos Sms Gateway

• Host: GitHub
• URL: https://github.com/thirunjuguna/mifos-sms-gateway
• Owner: thirunjuguna
• License: mpl-2.0
• Created: 2019-07-16T07:09:43.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-07-29T02:27:05.000Z (over 3 years ago)
• Last Synced: 2023-03-02T16:02:41.730Z (almost 2 years ago)
• Language: Java
• Size: 135 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mifos-sms-gateway

## Build set up

##### To create standalone application:

  ./gradlew clean build 

##### To run 

  cd build/lib

  

  java -jar mifos-sms-gateway-0.0.1.jar

##### To create deployable war:

./gradlew clean build -Pprofile=deployable

war file can be found in build/libs

 

##Steps to configure Mifos SMS Gateway

#### Create tenant with http://host:9191/tenants/

	method: POST

	Request Body:

	

	{

		"tenantId" : "Tenant Id",

		"description" : "Some Description"

	}

	

 This API will return an unique tenant app key. This key should not be shared with others. 

 

#### Create Twilio SMS Bridge with http://host:9191/smsbridges

 	method: POST

 	HEADERS:

 		Fineract-Platform-TenantId:tenantId

 		Fineract-Tenant-App-Key:generatedAppkeywhilecreatingtenant

 	Request Body:

 	{

		"phoneNo": "+xxxxxxxxxxx",

		"providerName": "Twilio Provider",

		"providerDescription": "SMS Provider for promotional messages",

		"providerKey":"Twilio",

		"countryCode":"+xx",

		"bridgeConfigurations": [

			{

				"configName":"Provider_Account_Id",

				"configValue":"xxxxx"

			},

			{

			"configName":"Provider_Auth_Token",

			"configValue":"xxxxx"

			}

		]

	}

	

This API will return Bridge Identifier by which you can use while sending SMS

#### Create Infobip SMS Bridge with http://host:9191/smsbridges

 	method: POST

 	HEADERS:

 		Fineract-Platform-TenantId:tenantId

 		Fineract-Tenant-App-Key:generatedAppkeywhilecreatingtenant

 	Request Body:

 	{

		"phoneNo": "+xxxxxxxxxxx",

		"providerName": "Infobip Provider",

		"providerDescription": "SMS Provider for transactional messages",

		"providerKey":"InfoBip",

		"countryCode":"+xx",

		"bridgeConfigurations": [

			{

				"configName":"Provider_Account_Id",

				"configValue":"xxxxx"

			},

			{

			"configName":"Provider_Auth_Token",

			"configValue":"xxxxx"

			}

		]

	}

	

This API will return Bridge Identifier by which you can use while sending SMS

	

#### Send SMS by using one of the provider with http://localhost:9191/sms

	Method: POST

	HEADERS:

 		Fineract-Platform-TenantId:tenantId

 		Fineract-Tenant-App-Key:generatedAppkeywhilecreatingtenant

 	Request Body:

 		

		[{

			"internalId":"55",

			"mobileNumber":"xxxxxxxxxx",

			"message":"Hello from Fineract",

			"providerId":"2"

		}]

Note: While sending SMS, don't include country code as part of each message. This country code will be prefixed by taking value from provider details. You need configure host-address: [your public ip on which message-gateway is running] in application.yml