Mifos User Documentation Portal
  • Overview and Background
    • History and Background
    • Mifos Vision, Mission & Values
    • Who Mifos is For
    • How Mifos is Used
    • The Mifos Stack
      • Overview
    • Mifos v/s Fineract
    • Community app v/s Webapps
  • General Contributing Guidelines
    • Upstream Development Approach
      • Contribution Process
      • The Apache Way
    • Contributors Guide
    • Contribution Guidelines: Android Project
    • Contribution Guidelines: Web Project
  • Getting Started
    • Getting started with Git & Github
    • Postman integration with Gitbook for testing
    • Testing framework-Web
    • Testing framework-Android
    • Mifos CI/CD tools and instructions
  • External 3rd Apps
    • Pentaho Reporting Plugin
    • Payment Hub
  • MifosX
    • Overview
    • User Manual
      • How to Use This Manual
      • For All Users
        • General Navigation
          • Sign In Page
          • Welcome Page
          • Dashboard Page
          • List Page
          • Menu Page
          • Form Page
          • Clients-Groups-Centers Navigation
          • Navigation Tool
          • Global Search
          • Loan Product and Accounting with Mifos
        • Reports
          • Standard Reports Shipped in Mifos X
          • Standard Reports Field Descriptions
          • Custom Reports
            • Creating Simple Pentaho Report and Embedding it to Mifos X
          • XBRL Reporting
      • For Administrators (Mifos X Platform)
        • Initial System Set Up
        • Administration
          • Users
          • Organization
            • Manage Offices
            • Currency Configuration
            • Manage Holidays
            • Manage Funds
            • Manage Employees
            • Bulk Loan Reassignment
            • Standing Instructions History
            • Teller / Cashier Management
            • Fund Mapping
            • Working Days
            • Password preferences
            • Payment type
            • Loan Provisioning Criteria
            • SMS Campaigns
            • Message Gateway Configuration
            • Daily Teller Cash Management
            • Entity Data Table Checks
          • System
            • Manage Data Tables
            • Audit Trails
            • Manage Codes
            • Manage Reports
            • Manage Roles and Permissions
            • Manage Scheduler Jobs
            • Configure Maker-Checker Tasks
            • Global Configuration
            • Manage Hooks
              • Steps for creating sms bridge
            • Account Number Preferences
            • Entity To Entity Mapping
              • External Services
          • Products
            • Loan Products
              • Loan Product Fields
                • Accounting Loan Product Fields
                • Configuring and Disbursing of Top-Up Loan
                • Declining Balance Interest Calculation
                • Enabling Floating Rate
                • Enabling Variable Installments
                • Flat interest calculation
                • Loan Product Fields—Additional Fields for Loans with Variable Terms based on Loan Cycle
                • Recalculate Interest
                • Tranche Loan Fields
              • Setting up Minimum Days between Disbursal and First Repayment
              • Product Mix
            • Charges
            • Floating Rate
            • Savings Products
              • Saving Product Fields
                • Accounting Saving Product Fields
            • Fixed Deposit Products
              • Fixed Deposit Product Fields
                • Accounting Fixed and Recurring Deposit Product Fields
              • Interest rate chart with amount range
            • Recurring Deposit
              • Recurring Deposit Product Fields
            • Interest Calculations for Deposit Products
            • Overdraft Product
            • Share products
              • Dividends
            • Manage Tax configuration
          • Templates
          • mifos dropdown
        • Clients, Groups and Centers
          • Manage Clients
            • Client Life Cycle Statuses
            • Client Relationship Management
          • Manage Groups
          • Manage Centers
        • Accounting
          • Chart of Accounts - General Ledger Setup
            • Default COA sql script
          • Accounts linked to Financial Activities
          • Migrate opening balances (Office-wise)
          • Accounting Rules
          • Provisioning Entries
          • Print General Ledger Listing
          • How To Enter GL Opening Balance
        • Configure Notifications
      • For Operational Users (Mifos X Web App)
        • Accounting operations
          • Add Journal Entries
          • Searching Accounting Transactions
          • Frequent Postings
          • Advanced Accounting Rules
          • Closing Entries
          • Accruals
        • Accounts and Transactions
          • Cash Transaction Processing
          • Deposit Accounts
            • Mifos X Saving Accounts
              • How to Activate a Saving Account
              • How to Add a Charge to a Saving Account
              • How to Approve a Saving Account Application
              • How to Calculate Interest for a Saving Account
              • How to Close a Saving Account
              • How to Create a Saving Account Application
                • Saving Account Fields
              • How to create overdraft account (Draft)
              • How to Delete a Saving Account Application
              • How to Make a Deposit to a Saving Account
              • How to Make a Withdrawal from a Saving Account
              • How to Modify a Saving Account Application
              • How to Post Interest to a Saving Account
              • How to Reject a Saving Account Application
              • How to Transfer funds from a Saving Account
              • How to Withdraw a Saving Account Application
            • Standing Instructions
              • How to Set up a Standing Instruction
                • Standing Instruction Form Fields
            • Term Deposit Accounts (Fixed Deposit / Recurring Deposit)
              • How to Activate a Term Deposit Account
              • How to Add a Charge to a Term Deposit Account
              • How to Approve a Term Deposit Account Application
              • How to Calculate Interest for a Term Deposit Account
              • How to Create a Term Deposit Account Application
                • Term Deposit Account Fields
              • How to Delete a Term Deposit Account Application
              • How to Make a Deposit to a Recurring Term Deposit Account
              • How to Modify a Term Deposit Account Application
              • How to Post Interest to a Term Deposit Account
              • How to Reject a Term Deposit Account Application
              • How to Withdraw a Term Deposit Account Application
            • Creating Recurring Deposit Account:
          • Loan Accounts
            • How to Create a Loan Account Application
              • Loan Account Fields
            • How to Make Repayments on a Client Loan Account
            • Track Loan Performance History
            • How to Approve a Loan Account Application
            • How to Add a Charge to a Loan Account
            • How to Modify a Loan Account Application
            • How to Assign a Loan Officer
            • How to Reject a Loan Account Application
            • How to Withdraw a Loan Account Application
            • How to Delete a Loan Account Application
            • How to Add Collateral to a Loan Account
            • How to Add/Remove/Modify a Guarantor to a Loan Account
            • How to Manage Loan Account Disbursement
            • How to Make Repayments on a Group Loan Account
            • Using collection sheet or other payment types for making payments
            • How to Waive Interest for a Loan Account
            • How to Write-off a Loan Account
            • How to Close a Loan Account as Rescheduled
            • How to Close a Loan Account
            • Making Prepay of the loan
            • How to Prepay a Loan Account
            • How To Create Group Loan Account
            • How to Process Bulk JLG Loan Application
            • How to generate - Loan transactions report
            • How to reschedule loan
            • How to provide floating rates
            • How to provide variable installments
            • How to create new loan - Interest Recalculation
            • Tranche loan process
            • Loan with term vary based on loan cycle
            • How to Place Guarantee Funds On-Hold?
          • Overdraft account
          • Saving Accounts
            • How To Create Group Saving Account
          • Share Accounts
        • Checker Inbox & Tasks
      • Side Bar - Features
        • Checker inbox and tasks
        • Collection sheet
        • Help.
        • Individual collection sheet
        • Keyboard short-cuts
        • Navigation
      • Others - mifos dropdown
        • Help
        • Profile
        • Settings
          • Date format
          • Language
        • Signout
      • Data Import Tool
        • Getting started with - Data Import Tool
        • Installing Data Import Tool
      • Glossary of Terms
      • Index
      • Reporting Documentation
      • Mobile Money Tool
    • User Space
      • New Feature Request Content
      • Recommended System Requirement
      • MifosX Overview
      • Installation guide
        • Upgrading Mifosx
        • Install MifosX on Windows
        • Install MifosX on Linux
        • Install MifosX on AWS
      • Release Notes
        • Release 1 and Features List
        • Release 2 and Features List
      • User Manual
        • How to Use This Manual
        • For All Users
          • General Navigation
            • Sign In Page
        • For Administrators
          • Initial System Set Up
        • For Operationals
      • Roadmap
      • Frequently Asked Questions (FAQs)
      • Demo Server Details
    • Developer Space
      • Setting Up Dev Environment
        • Setting up Frontend - community-app
      • Setting up MifosX from latest builds
      • Contributors Guide
      • Customising MifosX
      • Additional features
        • Data import tool
        • SMS campaigns
        • Pentaho reports
      • How Mifosx works
      • Adding a new tenant to MifosX instance
      • Using REST client for testing
      • API documentation
      • Scaling MifosX
      • Upgrading MifosX
      • Troubleshooting guide
  • Core Banking & Embedded Finance
    • Core Banking
      • Overview
    • Embedded Finance
      • Overview
  • Application Framework
    • Payment Hub EE
  • Main Platforms
    • Fineract 1.x
      • Apache Fineract
      • Apache Fineract Client
    • Fineract CN
      • Overview
      • User Manual
  • Staff UI Platforms
    • Fineract 1.x
      • Community-App
      • Web-App
      • Web Self-Service App
        • Online Banking App 2.0 User Manual
          • Developer Environment Setup for Online Banking App 2.0
      • Mobile Field Officer Applications
        • Android Client
          • User Manual
    • Fineract CN
      • Digital Bank User Interface
      • Mobile Field Officer Applications
        • Fineract CN Mobile
  • Customer UI Platforms
    • Fineract 1.x
      • Mobile Banking
        • Mifos Mobile
      • Mobile Wallets
      • Online Banking
    • Fineract CN
      • Mobile Banking
        • Fineract CN Mobile
        • Mifos Mobile CN
      • Mobile Wallets
      • Online Banking
  • Ancillary Tools
    • Fineract 1.x
      • Message Gateway
      • Mifos Passcode
      • PPI Vision
      • DevOps Tooling
      • Fineract Android SDK
      • MifosX Admin
      • Mifos ChatBot
      • Data Import Tool
    • Fineract CN
      • Fineract CN Containers
      • Fineract CN Terraform
  • Payment and Process Orchestration
    • Fineract 1.x
      • Payment Hub
      • Fineract Pentaho
    • Fineract CN
      • Staff Interfaces
        • Digital Bank UI
      • Customer Interfaces
        • Fineract CN Mobile
        • Mifos Mobile CN
        • Fineract CN Mobile
      • Ancillary Tools
        • Fineract CN Terraform
        • Fineract CN Containers
    • Payment Hub EE
Powered by GitBook
On this page
  • Configuring Message Gateway in Platform
  • How to Create SMS Campaigns
  • How to Activate an SMS Campaign
  • How to check the status of the SMS

Was this helpful?

  1. MifosX
  2. User Manual
  3. For Administrators (Mifos X Platform)
  4. Administration
  5. Organization

SMS Campaigns

PreviousLoan Provisioning CriteriaNextMessage Gateway Configuration

Last updated 5 years ago

Was this helpful?

Setup Message Gateway Before creating SMS Campaigns

Create a Message-Gateway before creating SMS Campaigns by following this link:

Configuring Message Gateway in Platform

Step 1: At the top the screen, navigate to Admin and select System from the drop-down.

Select External Services

Step 2: Next Click External Services (SMS Service Configuration)

Step 4: Set the following parameters in Edit External Service Configuration

host_name: Use the {Message-gateway host name}

Port_Number: It should be 9191

end_point: Set end point as message-gateway-0.0.1/

tenant_app_key: {Paste the same tenant_app_key that is generated while configuring Message-Gateway}

Step 5: Click Submit.

How to Create SMS Campaigns

Step 1: At the top the screen, navigate to Admin and select Organization from the drop-down menu.

Select SMS Campaigns

Step 3: Here you find a three step process from Campaign to Message to Preview. At the campaign stage, fill out these details;

Define the "Message Details" for the SMS Campaign.

  • Campaign Name: Provide a name for the SMS Campaign.

  • Is Notification: By default, the campaign is not a notification and therefore you are required to provide the SMS Provider. If the campaign is of notification kind, please check the check box. This will disable the SMS provider section and you may then proceed to the trigger type.

When it Is Not a Notification;

  • SMS Provider: Select the appropriate SMS provider from the drop down menu.

When it Is a Notification;

No need for SMS provider

  • Trigger Type: You can set "Trigger type" as either 'Direct', 'Scheduled', or 'Triggered'. Choose one from the drop down menu.

  • Choose Direct when you want to send the SMS only once.

  • Choose Scheduled if you want to send multiple SMS for a particular 'date' and 'Time'.

  • Choose Triggered when you want to send 'transactional' SMS (For Example: Loan Repayment, Savings Deposit, Savings Withdrawal, etc. Currently 9 types of transactional campaigns are supported)

If you select Direct or Triggered, you may then proceed to the Business Rule part of the page. However, if you select Scheduled, then you will be required to provide additional information like Schedule Date and Schedule Time;

  • Scheduled Date: Choose the date you want the campaign to take place or start (in the event that the campaign will not be for a day)

  • Scheduled Time: Choose the time you want the campaign to run. Also select when you want the campaign to be repeated and the interval of repetition.

  • Business Rule: Select the appropriate business rule from the drop down menu. Depending on the option you choose, a new set of sections will be displayed under the Business Rule Parameters section at the end of the page. As an example, we select Loan Payment Due as Business Rule and the Business Rule Parameters are Office, From X Number and To Y Number.

Depending on your Business Rule selection, fill in the required fields.

Step 4: Next is the Campaign Message Section.

The Available Template Parameters vary according to the Business Rule you selected in the previous section.

Choose those which apply to the campaign message you wish to broadcast. These available templates act as placeholders for the various options. For example, if you want to capture the first name of the client in the message, select firstName and it will be added into the Campaign Message textbox.

After which, you can then choose to activate the campaign or edit.

How to Activate an SMS Campaign

From the general list of SMS Campaign, select the Campaign you want to make active. This should launch the details of the campaign like the screenshot below:

Click the Activate button which will launch a pop-up dialog box in which you should provide the current date.

If you want the campaign to begin on another day, you have to wait till that day arrives and then you provide that date in the Activate date field.

Also you may not be able to edit the details of the campaign once you Confirm. Ensure that the provided details are according to your preference.

After choosing the date, click the Confirm button.

Your SMS Campaign has successfully been created and marked active in the general SMS Campaign page.

From the SMS campaign window, you can see the SMS campaign names that are at the active,closed and pending stages.

How to check the status of the SMS

To check the status of your campaign, select the campaign from the general SMS Campaign page. At the top of the campaign details, there are tabs with the different campaign statuses. Select the status you want to view.

In each case, set "From Date" and "To Date" parameters. This will provide a list of SMS if applicable.

To send pending SMS, please run the scheduler job "Send Messages to SMS Gateway". This can be achieved by navigating to Admin>>System>>Scheduler Jobs.

Step 3: Click button at the top-right of the page

Step 2: On the SMS Campaigns page, click on button to create a new SMS Campaign

Check to confirm your inputs and then Click

After composing your message and adding the placeholders provided, click .

Step 5: Preview avails you the opportunity to check the information you have provided. Click the button to finish.

https://mifosforge.jira.com/wiki/display/docs/Message+Gateway+Configuration