CrunchzApp icon

CrunchzApp

Interact with CrunchzApp API

Actions22

Overview

This node interacts with the CrunchzApp API to request a One-Time Password (OTP) code for a specified contact. It allows users to customize the OTP code's characteristics such as length, character composition (letters and/or numbers), capitalization, and expiration time. This is useful in scenarios where secure verification or authentication via OTP is required, for example, sending an OTP to a user's phone number for login confirmation or transaction validation.

Practical examples:

  • Generating a 6-digit numeric OTP to verify a user's phone number during registration.
  • Creating an alphanumeric OTP with uppercase letters for enhanced security in two-factor authentication.
  • Setting a custom expiration time for the OTP to limit its validity period.

Properties

Name Meaning
Length The length of the OTP code to generate.
Use Letter Whether to include letters in the OTP code (true/false).
Use Number Whether to include numbers in the OTP code (true/false).
All Capital Whether to convert all characters in the OTP code to uppercase (true/false).
Name The name of the entity requesting the OTP (e.g., user or system identifier).
Expires The expiration time of the OTP code in seconds.
Contact Id Required. The contact identifier to which the OTP will be sent (e.g., phone number).

Output

The node outputs JSON data containing the response from the CrunchzApp API after requesting the OTP code. This typically includes details about the generated OTP, its status, and any metadata returned by the API. The exact structure depends on the API response but generally confirms successful OTP generation and delivery.

If binary data were involved (e.g., QR codes or images), it would be summarized here, but this node focuses on JSON output related to OTP requests.

Dependencies

  • Requires an active CrunchzApp API key credential configured in n8n for authentication.
  • Depends on the CrunchzApp API endpoint at https://api.crunchz.app/api.
  • No additional external services are needed beyond the CrunchzApp API.

Troubleshooting

  • Missing or invalid Contact Id: The node requires a valid contact identifier; ensure the Contact Id is correctly formatted (e.g., including country code and domain like @c.us).
  • API authentication errors: Verify that the CrunchzApp API key credential is correctly set up and has necessary permissions.
  • Invalid property values: For example, setting Length to zero or negative may cause errors; ensure Length is a positive integer.
  • Network issues: Connectivity problems with the CrunchzApp API endpoint can cause request failures; check network access and API availability.
  • Unexpected API responses: If the API returns errors, review the error message for guidance and confirm that all required properties are provided.

Links and References

Discussion