n8n-nodes-farazsms

Community node package that wraps the @aspianet/faraz-sms SDK to bring the Faraz SMS REST API into your n8n workflows.

Features

This package adds a single Faraz SMS node with the following operations:

| Operation | Description | |-----------|-------------| | farazAuth | Fetch the authenticated Faraz SMS account profile | | farazCredit | Retrieve the remaining credit balance | | farazSendSMS | Send a standard SMS message | | farazGetSMS | Fetch the details of a sent message by its bulk ID | | farazCreatePattern | Create a new SMS pattern (template) | | farazSendPattern | Send a pattern-based message using an approved pattern code | | farazGetMessageRecipientsStatus | Retrieve delivery statuses for message recipients | | farazFetchInboxMessages | Fetch received inbox messages |

Installation

Install the package inside your n8n installation folder:

npm install n8n-nodes-farazsms

Restart n8n so it can load the new node.

Credentials

Create new credentials of type Faraz SMS API and paste the API key provided in your Faraz SMS dashboard. The node uses this key to authenticate every request via the official SDK.

Usage

Drag the Faraz SMS node into a workflow, select the desired operation, and fill out the required fields:

• Send SMS – specify your sender line (Originator), one or more recipient numbers, and the message body.
• Send SMS – specify your sender line (Originator), one or more recipient numbers, the message body, and optionally schedule a future send time.
• Send Pattern – supply the pattern code, sender, recipient, and a JSON object that maps pattern variables to values, e.g. { "name": "John" }.
• Fetch operations – provide the requested identifiers (bulk ID) where relevant.

All responses from the Faraz SMS API are returned as JSON so you can continue processing them in downstream nodes.

Development

npm install
npm run build

The build command compiles the TypeScript sources into the dist folder that n8n expects when loading community nodes.