@stacksjs/sms
v0.59.11
Published
The Stacks SMS integration. Painlessly create & manage your inboxes, templates, and send sms.
Downloads
190
Maintainers
Readme
Stacks SMS
Stacks SMS is driver system for sending SMS messages.
☘️ Features
- 📦 Send SMS
🤖 Usage
bun install -d @stacksjs/sms
You may now use it in your project:
import * as sms from '@stacksjs/sms'
/* Then choose a driver. E.g for twilio */
const notification = sms.twilio
notification.send(SMSOptions)
interface SMSOptions {
to: string
content: string
from?: string
attachments?: AttachmentOptions[]
id?: string
}
Drivers
Drivers are configured with the following environment variables:
Twilio
TWILIO_ACCOUNT_SID=ACtest
TWILIO_AUTH_TOKEN=testtoken
TWILIO_FROM_NUMBER=+112345
TWILIO_TO_NUMBER=+145678
Nexmo
VONAGE_API_KEY=VN123
VONAGE_API_SECRET=testkey
VONAGE_FROM_NUMBER=+112345
Gupshup
GUPSHUP_USER_ID=GU123
GUPSHUP_PASSWORD=password
Plivo
PLIVO_ACCOUNT_ID=PA123
PLIVO_AUTH_TOKEN=testtoken
PLIVO_FROM_NUMBER=+112345
SMS77
SMS77_API_KEY=SA123
[email protected]
SNS
SMS77_API_KEY=SA123
[email protected]
Telnyx
TELNYX_API_KEY=TA123
TELNYX_MESSAGE_PROFILE_ID=testprofileid
[email protected]
Termii
TERMII_API_KEY=TermA123
[email protected]
Learn more in the docs.
🧪 Testing
bun test
📈 Changelog
Please see our releases page for more information on what has changed recently.
🚜 Contributing
Please review the Contributing Guide for details.
🏝 Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
For casual chit-chat with others using this package:
Join the Stacks Discord Server
🙏🏼 Credits
Many thanks to the following core technologies & people who have contributed to this package:
📄 License
The MIT License (MIT). Please see LICENSE for more information.
Made with 💙