Free Mobile SMS API
This package let you send SMS to your Free Mobile number using the official API.
Requirements
- You need an activated Free Mobile phone number
- The option "Notifications par SMS" must be activated on the account settings page
Installation
Using yarn:
yarn add free-mobile-sms-api
Using NPM
npm install free-mobile-sms-api
Requirements
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 |
Usage
Firstly you need to instantiate the package
then you can:
Send instantly a message
sms.send"Hello world!".thenconsole.log.catchconsole.error
Queue your messages to ensure to deliver them in the right order. Queueing a message return the queued message internal UUID
You can also queue many messages at once:
You can remove any queued element until it were sent
sms.removesmsId;
You can get the full list of queued sms too
freeMobileSmsApi.entries;// [[id, message],[id, message]...]
Codes:
- 200 Success
- 400 One of needed parameters is missing or incorrect
- 402 Too many requests sent, please wait few time
- 403 Access denied, check your credentials
- 500 SMS API got an internal error, try again later
Disclaimer
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.