mgeiss / mifos-twilio-bridge

5 stars 20 forks source link

mifos-twilio-bridge

Summary

mifos-twilio-bridge provides a RESTful interface to send SMS based on events send by the Mifos X Platform.

Needed additional information is requested via the Mifos X Platform and a SMS message is created and send using Twilio.

Execution

Simply use the gradle task bootRun or build the project and run the executable jar file by calling:

java -jar mifos-twilio-bridge-0.0.1.jar

API Documentation

Resources

Path Type Header Parameter Body Result
/modules/sms POST X-Mifos-API-Key
X-Mifos-Entity
X-Mifos-Action
none Stringified JSON 200
401
404

Available Entities and Actions

Entity Action Body
client create {"officeId":1,"clientId":1,"savingsId":1,"resourceId":1}
loan repayment {"officeId":1,"clientId":1,"loanId":1,"resourceId":1}
sms send {"mobileNo":"1234567890","message":"Custom message"}

People

Markus Geiss (markus.geiss@live.de).

License

Copyright 2014 Markus Geiss

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.