./gradlew clean build
cd build/lib
java -jar message-gateway-0.0.1.jar
./gradlew clean build -Pprofile=deployable
war file can be found in build/libs
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.
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
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
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
Include following url in build.gradle:
https://fynarfin.jfrog.io/artifactory/fyn-libs-release-local.
And add the following line under depedencies in build.gradle
implementation 'com.telerivet:TelerivetAPIClient:1.5.0'