Overview
This node integrates with the Taximail API to send SMS One-Time Passwords (OTPs) for user verification purposes. It is designed to facilitate secure authentication workflows by sending OTP codes via SMS using predefined templates. Typical use cases include two-factor authentication, password resets, or any scenario requiring temporary verification codes sent to users' mobile phones.
For example, a business can use this node to send an OTP SMS to a customer’s phone number during login to verify their identity before granting access.
Properties
| Name | Meaning |
|---|---|
| To Phone (MSISDN) | Recipient's phone number including country code (e.g., 66812345678). |
| OTP SMS Template Key | The template key identifying the SMS message format used for sending the OTP. 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, which should be saved for later OTP verification.otp_ref_no: A reference number related to the OTP transaction.note: A message advising to save the message ID and reference number for verification.verification_info: An object containing:message_id: Same as above.otp_ref_no: Same as above.next_step: Instruction to use the message ID for verifying the OTP entered by the user.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating requests to the Taximail API.
- The node uses HTTP requests with form-urlencoded bodies to communicate with the Taximail service endpoints.
- No additional environment variables are explicitly required beyond the API key credential configuration in n8n.
Troubleshooting
- Missing OTP SMS 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.
- API Request Failures: Network issues or invalid API credentials may cause the request to fail. Verify the API key credential is correctly configured and active.
- Invalid Phone Number Format: The recipient phone number must include the country code and be in the correct format; otherwise, the SMS may not be delivered.
- Saving Message IDs: Users must save the returned
message_idandotp_ref_noto verify the OTP later. Failure to do so will prevent OTP verification. - Error Messages: Common errors include "Operation failed" for general failures and specific messages like "OTP verification failed - invalid code or expired" during OTP validation.
Links and References
- Taximail API Documentation (for detailed API usage and template management)
- n8n Documentation on Creating Custom Nodes