node-red-contrib-farazsms

FarazSMS · IranPayamak (فراز اس ام اس · ایران پیامک) — official Node-RED nodes for sending and receiving SMS through the FarazSMS REST API. 🌐 farazsms.com · iranpayamak.com · 📚 docs.farazsms.com/node-red

Drag-and-drop SMS into your automations: OTP, pattern, bulk send, scheduling, delivery status, inbound messages and the phonebook — with built-in rate-limiting, automatic retry and error reporting.

Install

From Node-RED: Menu → Manage palette → Install and search for node-red-contrib-farazsms.

Or from the command line in your Node-RED user directory (~/.node-red):

npm install node-red-contrib-farazsms

Nodes

| Node | What it does | Endpoint | |------|--------------|----------| | FarazSMS account (config) | Holds your Api-Key, sender line, rate-limit & retry | — | | send | Bulk / simple text & variable (keyword) SMS, with scheduling | /ws/v1/sms/simple, /ws/v1/sms/keywords | | pattern / OTP | Pattern (template) SMS + one-line OTP (auto code → msg.otp) | /ws/v1/sms/pattern | | delivery | Delivery status: single request, per-recipient items, recent list | /ws/v1/send_request… | | inbound | Read received SMS; optional polling emits one msg per new reply | /ws/v1/inbox | | phonebook | List phonebooks/contacts, add & bulk-upsert contacts | /ws/v1/phone_book… |

Quick start

1. Drag a FarazSMS pattern / OTP node onto the canvas.
2. Double-click it, add a FarazSMS account, paste your Api-Key (panel → Services & Web service → Access keys).
3. Set mode = OTP, enter your pattern code, wire an inject → pattern/OTP → debug.
4. Deploy and click inject — the code is in msg.otp, the API response in msg.payload.

Covered requirements

Send SMS · OTP · Pattern · Delivery status · Inbound · Phonebook · Scheduling · Bulk send · Rate limit · Auto-retry · Error reporting (via Catch node + msg.error) · Variable support (msg-driven attributes).

Errors

Every node raises failures through node.error(err, msg) so you can wire a Catch node; details are also on msg.error ({message, statusCode, body}).

License

MIT © FarazSMS · IranPayamak