Overview
This node integrates with the Taximail API to send SMS One-Time Passwords (OTPs) for authentication or verification purposes. It is designed to send OTP messages using predefined SMS templates, making it useful in scenarios such as user login verification, password resets, two-factor authentication, or any process requiring secure temporary codes sent via SMS.
For example, when a user requests a login code, this node can send an OTP SMS to their phone number using a specified template. The message ID returned can be saved and later used to verify the OTP entered by the user or check the delivery status.
Properties
| Name | Meaning |
|---|---|
| To Phone (MSISDN) | Recipient phone number including country code (e.g., 66812345678). Required. |
| OTP SMS Template Key | Template key identifying the SMS template to use for sending the OTP message. Required. |
Output
The node outputs a JSON object containing the response from the Taximail API after attempting to send the OTP SMS. Key fields include:
operation: The operation performed, here always"sms_otp".message_id: A unique identifier for the sent OTP message. This should be saved for later OTP verification or status checking.- Additional API response data related to the OTP sending request.
note: A message advising to save themessage_idfor future verification.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for HTTP Basic Authentication to access the Taximail API.
- The node uses the Taximail API endpoints for transactional messaging and OTP services.
- Network connectivity to
https://api.taximail.comis necessary.
Troubleshooting
- Missing OTP Template Key: If the "OTP SMS Template Key" property is empty or missing, the node will throw an error stating that the OTP template key is required. Ensure this field is filled with a valid template key.
- Invalid Phone Number Format: The "To Phone (MSISDN)" must include the country code and be correctly formatted; otherwise, the API may reject the request.
- API Authentication Errors: Incorrect or missing API credentials will cause authentication failures. Verify that the API key credential is correctly configured.
- Network Issues: Connectivity problems to the Taximail API endpoint will result in request failures.
- Operation Failures: Any unexpected errors during the API call will be wrapped and reported as operation failures with the original error message.
Links and References
- Taximail Official API Documentation (for detailed API usage and template management)
- n8n Documentation on Credentials (for setting up API authentication)