SMSAPI

1npm install @yanchesky/medusa-smsapi
2# or
3yarn add @yanchesky/medusa-smsapi

1SMSAPI_ACCESS_TOKEN=your_smsapi_access_token_here
2SMSAPI_FROM=YourBrand

1import { SMSAPIOptions } from '@yanchesky/medusa-smsapi';
2// ...
3module.exports = {
4  // ... other configurations
5  modules: [
6    // ... other modules
7    {
8      resolve: '@yanchesky/medusa-smsapi/providers/smsapi',
9      dependencies: ['logger'] // Optional in test mode to log sent messages
10      options: {
11        channels: ['sms'], // Required: notification channels
12        access_token: process.env.SMSAPI_ACCESS_TOKEN,
13        from: process.env.SMSAPI_FROM,
14      } satisfies SMSAPIOptions,
15    },
16  ],
17}

1import { Modules } from '@medusajs/framework/utils';
2// ...
3const notificationService = container.resolve(Modules.NOTIFICATION);
4await notificationService.createNotifications([{
5  channel: 'sms',
6  to: '48123456789', // Country prefix is required
7  template: 'confrimation' // This is required by Medusa but is not used by the plugin. 
8  content: {
9    text: "An SMS message"
10  }
11}])

1interface SMSAPIOptions {
2  // Required
3  access_token: string     // Your SMSAPI access token
4  from: string             // Sender name verified by SMSAPI
5  channels: string[]       // Notification channels
6
7  // Optional Basic Settings
8  encoding?: string        // Message encoding (default: "UTF-8")
9  test?: boolean           // Test mode (default: false)
10  api_url?: string         // API endpoint (default: "https://smsapi.io/api")
11
12  // Optional Advanced Settings
13  flash?: boolean          // Flash SMS (default: false)
14  max_parts?: 1-10         // Maximum number of parts a message can be split into
15  nounicode?: boolean      // Prevents from sending messages containing special characters.
16  normalize?: boolean      // Converts special characters to regular ones. ę -> e; ć -> c
17  fast?: boolean           // Send SMS with the highest priority (default: false)
18}

1# Run type checking
2yarn typecheck
3# Run linting
4yarn lint
5# Format code
6yarn format
7# Build plugin
8yarn build