SMSAPI
Send SMS with optional test mode for safe messaging
Medusa v2 SMSAPI Plugin
A notification provider plugin that enables SMS notifications via SMSAPI.com and service for Medusa v2 projects.
Table of Contents
- Features
- Prerequisites
- Installation
- Configuration
- Environment Variables
- Usage
- Configuration Options
- Development
- Contributing
- Support
- License
Features
- SMS Notifications: Send SMS via SMSAPI.io service
- Test Mode: Safe testing without sending actual SMS
Prerequisites
- Medusa v2.4.0+
- Node.js 20+
- SMSAPI.io Account with API access token
- Active SMS credits in your SMSAPI account
Installation
Configuration
1. Environment Variables
Create or update your file:
2. Medusa Configuration
Add the plugin to your :
Usage
Basic SMS Sending
Configuration Options
SMSAPIOptions Interface
Test Mode
Enable test mode to validate your setup without sending actual SMS. In test mode a request to API endpoint will be executed validating credentials and logging sent message.
Local Development
Contributing
All contributions are welcome! Please follow these steps:
- Fork the repository
- Create a feature branch ()
- Make your changes
- Run quality checks ()
- Commit your changes ()
- Push to the branch ()
- Open a Pull Request
Development Guidelines
- Follow existing code style and conventions
- Add TypeScript types for all new features
- Include comprehensive error handling
- Update documentation for new features
Support
- ๐ Documentation: Medusa Documentation
- ๐ SMSAPI Docs: SMSAPI.io Documentation
- ๐ Issues: GitHub Issues
License
MIT License
Compatibility
- โ Medusa: v2.4.0+
- โ Node.js: 20+
- โ TypeScript: 5+
- โ OPEN API: Latest API version

