Kavenegar SMS icon

Kavenegar SMS

Send an SMS through Kavenegar API

Overview

This node integrates with the Kavenegar API to perform SMS-related operations. Specifically, for the "Otp Verification" operation, it verifies one or more OTP (One-Time Password) tokens sent to a receptor (phone number) using a specified verification template. This is useful in scenarios where you want to confirm user identity or validate actions via OTP codes sent through SMS.

Practical examples include:

  • Verifying a user's login or transaction by checking the OTP they received.
  • Confirming phone number ownership during registration.
  • Multi-token verification when multiple OTPs are involved.

Properties

Name Meaning
Receptor The phone number that received the OTP and will be verified.
Token The primary OTP token to verify.
Token 2 An optional second OTP token to verify.
Token 3 An optional third OTP token to verify.
Template The name of the verification template used by Kavenegar API to check the OTP(s).

Output

The node outputs JSON data containing:

  • response: The raw response from the Kavenegar API regarding the OTP verification status.
  • verified: A boolean flag set to true indicating the OTP verification was attempted.
  • receptor: The phone number against which the OTP verification was performed.
  • token, token2, token3: The OTP tokens submitted for verification.

No binary data output is produced by this operation.

Dependencies

  • Requires an active Kavenegar API key credential configured in n8n.
  • Uses the Kavenegar REST API endpoint for OTP verification.
  • Network access to https://api.kavenegar.com must be available.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Incorrect receptor phone number format may lead to failed verification.
    • Using an invalid or expired OTP token will result in unsuccessful verification.
    • Not providing the required template name will cause errors.
  • Error messages:

    • "No credentials got returned!": Indicates the API key credential is not set or accessible; ensure the credential is properly configured.
    • API errors returned from Kavenegar (e.g., invalid token, template not found) will be included in the response field; review these messages for specific causes.
  • To resolve errors, verify credentials, input values, and ensure the template exists and matches what was used to send the OTP.

Links and References

Discussion