SMSAPI

123
npm install @yanchesky/medusa-smsapi
# or
yarn add @yanchesky/medusa-smsapi

12
SMSAPI_ACCESS_TOKEN=your_smsapi_access_token_here
SMSAPI_FROM=YourBrand

1234567891011121314151617
import { SMSAPIOptions } from '@yanchesky/medusa-smsapi';
// ...
module.exports = {
  // ... other configurations
  modules: [
    // ... other modules
    {
      resolve: '@yanchesky/medusa-smsapi/providers/smsapi',
      dependencies: ['logger'] // Optional in test mode to log sent messages
      options: {
        channels: ['sms'], // Required: notification channels
        access_token: process.env.SMSAPI_ACCESS_TOKEN,
        from: process.env.SMSAPI_FROM,
      } satisfies SMSAPIOptions,
    },
  ],
}

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

123456789101112131415161718
interface SMSAPIOptions {
  // Required
  access_token: string     // Your SMSAPI access token
  from: string             // Sender name verified by SMSAPI
  channels: string[]       // Notification channels

  // Optional Basic Settings
  encoding?: string        // Message encoding (default: "UTF-8")
  test?: boolean           // Test mode (default: false)
  api_url?: string         // API endpoint (default: "https://smsapi.io/api")

  // Optional Advanced Settings
  flash?: boolean          // Flash SMS (default: false)
  max_parts?: 1-10         // Maximum number of parts a message can be split into
  nounicode?: boolean      // Prevents from sending messages containing special characters.
  normalize?: boolean      // Converts special characters to regular ones. ę -> e; ć -> c
  fast?: boolean           // Send SMS with the highest priority (default: false)
}

12345678
# Run type checking
yarn typecheck
# Run linting
yarn lint
# Format code
yarn format
# Build plugin
yarn build