Faraz SMS icon

Faraz SMS

Interact with the Faraz SMS REST API
Join our community

Actions8

Overview

This node integrates with the Faraz SMS REST API to send SMS messages using approved SMS patterns. It is useful for automating the sending of templated SMS messages where variables in the pattern are dynamically replaced with actual values. For example, businesses can send personalized notifications or alerts to customers using predefined message templates approved by Faraz SMS.

Use Case Examples

  1. Sending a notification SMS to a customer using an approved pattern code with dynamic values such as customer name and appointment time.
  2. Automating bulk SMS campaigns where each recipient receives a personalized message based on a pattern.

Properties

Name Meaning
Pattern Code The approved pattern code received from Faraz SMS, identifying the SMS template to use.
Pattern Originator The sender line number from which the pattern message will be sent.
Recipient The mobile number of the recipient who will receive the pattern message.
Pattern Values A JSON object containing key/value pairs that map pattern variables to their actual values for message personalization.

Output

JSON

  • bulkId - Unique identifier for the sent bulk message.
  • message - The content of the sent message.
  • status - Status of the message sending operation.
  • recipient - The recipient mobile number of the sent message.

Dependencies

  • Faraz SMS REST API
  • An API key credential for Faraz SMS API authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and valid; missing or invalid keys will cause authentication errors.
  • Pattern values must be valid JSON; invalid JSON will cause parsing errors.
  • The pattern code must be approved by Faraz SMS; using an unapproved code will result in API errors.
  • Check the sender line number (originator) is registered and authorized in the Faraz SMS panel.
  • Common error messages include HTTP status codes and descriptive messages from the Faraz SMS API, which help identify issues such as invalid parameters or authentication failures.

Links

Discussion