Free Mobile SMS API - Give you a simplified way to use the official SMS API powered by Free mobile
OTHER License
This package let you send SMS to your Free Mobile number using the official API.
Using yarn:
yarn add free-mobile-sms-api
Using NPM
npm install free-mobile-sms-api
Setting up environment variables:
Variable | Description |
---|---|
FREE_MOBILE_SMS_API_USER |
Your user account ID, it's your login on Free Mobile website |
FREE_MOBILE_SMS_API_PASSWORD |
The key provided in your account settings page |
Firstly you need to instantiate the package
import {freeMobileSmsApi} from "free-mobile-sms-api"
const sms: FreeMobileSmsApi = new FreeMobileSmsApi()
then you can:
Send instantly a message
sms.send("Hello world!").then(console.log).catch(console.error)
Queue your messages to ensure to deliver them in the right order. Queueing a message return the queued message internal UUID
const smsId: string = sms.queueMessage("Hello world!")
You can also queue many messages at once:
const smsIds: string[] = sms.queueMessages([
"Hello world! 1/3"
, "Hello world! 2/3"
, "Hello world! 3/3"
])
You can remove any queued element until it were sent
sms.remove(smsId);
You can get the full list of queued sms too
freeMobileSmsApi.entries();
// [[id, message],[id, message]...]
This package doesn't use a complex queue mechanism for one reason, Free Mobile provide this feature for a fair usage, you're not supposed to spam their API during the whole days with thousands queries.
For my own usage i rarely reach 50 SMS/day with some batches of 15-20 messages sent if few seconds, everything run smooth.
I never encountered a 402
error since 7 years I'm using it.