First Verification
1. Prerequisites
To use EngageLab OTP to generate, send, and verify one-time passwords, developers need to complete the following preparations before getting started:
1.1 Configure a template
Follow the instructions in Create an OTP Template to configure the template name, template ID, brand name, one-time password length, expiration time, and other information required for sending EngageLab OTP messages.
1.2 Create an API key
When using the EngageLab OTP API to generate or verify one-time passwords, you need to create an API Basic Authentication key. You can follow the instructions in Create an OTP API Key.
2. Send officially
You can choose one of two methods to send your first EngageLab OTP verification message:
2.1 Send from the website console
- 2.1.1 Generate and send a verification code
Log in to the EngageLab website console, go to [API Debugging] -> [OTP Send], and enter the created API key, target mobile number or email address, template ID, and template language in order on the page:
After entering the above information, click Send OTP Request to generate a verification code and send it to the specified target mobile number or email address.
If the request is successful, you can see the response channel used for sending and the message_id in the Response box below:
If the request fails, you can see the specific error code and error message in the Response box below:
After the message is sent successfully, click message details in the history to view the generated one-time password and message_id.
- 2.1.2 Verify the verification code
Log in to the EngageLab website console, go to [API Debugging] -> [OTP Verification], and enter the created API key, message_id, and the generated one-time password in order on the page. After completing the form, click the Verify OTP Request button:
2.2 API integration
Integrate with the EngageLab OTP API through code. For details, refer to the following two documents:
3. View history
After a successful send, you can view information such as the template name, send time, recipient, message status, and estimated cost on the History page. For details, refer to: EngageLab OTP History
