Faraz SMS icon

Faraz SMS

Interact with the Faraz SMS REST API

Overview

This node interacts with the Faraz SMS REST API to create a reusable SMS pattern. It allows users to define a pattern body with variables, provide a description for identification, and specify whether the pattern should be shared. This operation is useful for setting up templated SMS messages that can be reused with variable substitution, streamlining the process of sending consistent messages with dynamic content.

Use Case Examples

  1. Creating a pattern for appointment reminders with variables like %name% and %date%.
  2. Defining a shared promotional message pattern for marketing campaigns.

Properties

Name Meaning
Pattern The SMS pattern body that includes variables like %name%.
Description A short description to help identify the pattern.
Shared Pattern Indicates whether the pattern should be shared with others.

Output

JSON

  • patternId - Identifier of the created pattern.
  • pattern - The pattern body as submitted.
  • description - Description of the pattern.
  • isShared - Boolean indicating if the pattern is shared.

Dependencies

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

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 if used in related operations; invalid JSON will cause errors.
  • The node throws errors if unsupported operations are requested; verify the operation name is correct.

Links

Discussion