Custom API SMS Gateway

A flexible custom API SMS gateway plugin for Moodle that allows integration with any messaging provider using HTTP requests. Ideal for connecting Moodle to WhatsApp, SMS, or other third-party communication platforms.
This plugin enables Moodle to send messages through any third-party service that supports HTTP API requests—making it a flexible and provider-agnostic messaging solution. Designed for maximum configurability, it allows administrators to define custom request types, headers, parameters, and authentication methods directly from the admin panel. Compatible with services like WhatsApp, Waziper, Zender, Twilio and SMSGlobal, this plugin integrates seamlessly with Moodle’s core messaging system starting from version 4.5+. It’s perfect for institutions needing a custom or local SMS integration without being tied to a specific vendor.
1. Overview
The   Custom API SMS Gateway   is a powerful and flexible Moodle plugin designed to connect Moodle’s messaging system to virtually any third-party SMS or messaging provider.
If your provider has an API that can be triggered by a simple HTTP GET or POST request, you can use this gateway. Instead of being locked into a specific provider, this plugin gives you a graphical interface to build the API request that matches your provider’s requirements, including custom headers, query parameters, and body data.
2. Key Features
Universal Compatibility:   Works with any SMS/messaging provider that has a basic HTTP API.
GET & POST Support:   Choose the HTTP method your provider requires.
Full Request Customization:
Define custom HTTP headers for authentication (e.g.,   Authorization: Bearer … ).
Build URL query string parameters.
Build request body data for POST requests.
Dynamic Placeholders:   Automatically insert the recipient’s phone number ( {{recipient}} ) and the message content ( {{message}} ) into any part of your request.
Custom Success Responses:   Define what a “successful” response from your provider’s API looks like to ensure messages are tracked correctly.
Built-in API Tester:   A live test utility on the settings page lets you send a test message and see the raw API response instantly, making setup and debugging incredibly simple.
3. Installation
Upload:   Upload the   customapi   folder to the   smsgateway/   directory of your Moodle installation. The final path should look like this:   your_moodle_site/smsgateway/customapi/
Install:   Log in to Moodle as an administrator and navigate to:   Site administration   >   Notifications   Moodle will detect the new plugin. Follow the on-screen prompts to install it by clicking the “Upgrade Moodle database now” button.
4. Configuration
This is where the power of the plugin lies. After installing, navigate to:   Site administration   >   Plugins   >   Message outputs   >   SMS