opscms-sms-plugin
v1.1.0
Published
Send notifications as text messages through Termii or Twilio, for an OpsCMS platform.
Maintainers
Readme
opscms-sms-plugin
Send notifications as text messages through Termii or Twilio. A channel plugin for the OpsCMS platform, built with opscms-sdk.
- The SMS channel: the platform's notification service asks it to send; it calls the provider's plain HTTP API (no SDK).
- Its own settings table,
sms-settings: the provider, the key and the sender id, for a site, an organization (used when a site has none) or the whole platform (used when neither has). Admins only; a site's admin never writes the platform-wide row. The key is encrypted and shown masked. - SMS among the owner alerts: where a site's owner is told about new orders and leads.
Termii takes one API key. Twilio takes AccountSid:AuthToken, and its From number as the sender id.
Install
From the admin: Plugins → Install from npm → opscms-sms-plugin. The platform creates the plugin's table (its one migration), lists the plugin with its logo,
and restarts to start it. Removing the plugin drops its table and the keys in it.
The platform currently carries this plugin in its own code under the same key; install the package only after that copy has been removed. List it after the platform's automation, which owns the notification settings.
Needs
payload ^3 and opscms-sdk ^0.1.4 (the platform provides both).
Develop
npm install
npm run typecheck && npm test && npm run build && npm pack --dry-runopscms-sdk is linked from a sibling checkout (file:../opscms-sdk) until it is published.
