Phone Number Verification Extension
Introduction
The Phone Number Verification Extension by Mr_koder is a powerful tool that enables apps developed to access the phone number verification service. It allows users to send SMS verification requests to any number in the world and verify security codes effortlessly. This extension leverages the Neutrino SMS Verify API for these functionalities.
Extension Overview
- Version: 1
- Description: This extension provides an interface to access the phone number verification service.
- Category: Extension
- Non-visible: Yes
Getting Started
Before using this extension, you need to set your API key and User ID for the phone number verification service. These can be obtained by signing up for the Neutrino SMS Verify API.
- API Key: Your API key for accessing the service.
- User ID: Your User ID for the phone number verification service.
Properties
1. API Key
- Description: Set or retrieve the API key for the phone number verification service.
- Type: Text
2. User ID
- Description: Set or retrieve the User ID for the phone number verification service.
- Type: Text
Functions
1. SendSMSVerification
- Description: Send an SMS verification request to a specified phone number.
-
Parameters:
-
phoneNumber(Text): The phone number to which the SMS verification request will be sent. -
lang(Text): The language code for the SMS message.available languages are:
- de - German
- en - English
- es - Spanish
- fr - French
- it - Italian
- pt - Portuguese
- ru - Russian
-
codelength(Number): The length of the security code. -
durationlimitindays(Number):Set the TTL in number of days that the ‘limit’ option will remember a phone number (the default is 1 day and the maximum is 365 days) -
brandName(Text): The brand name to be displayed in the SMS message. -
limit(Number): Limit the total number of SMS allowed to the supplied phone number, if the limit is reached within the TTL then error code 14 will be returned.
-
Example:
blocksCopy code
PhoneNumberVerify.SendSMSVerification("+1234567890", "en", 6, 7, "MyApp", 3)
2. VerifySecurityCode
-
Description: Verify a security code received from the
. -
Parameters:
-
code(Text): The security code to be verified.
-
Example:
blocksCopy code
PhoneNumberVerify.VerifySecurityCode("123456")
Events
1. SMSVerificationResult
- Description: Triggered when an SMS verification request is processed.
-
Parameters:
-
numberValid(Boolean): Indicates whether the phone number is valid. -
securityCode(Text): The security code received in the SMS. -
sent(Boolean): Indicates whether the SMS was sent successfully.
-
Example:
blocksCopy code
When PhoneNumberVerify.SMSVerificationResult(numberValid, securityCode, sent)
// Handle the SMS verification result here
End
2. SMSErrorOccurred
- Description: Triggered when an error occurs during SMS verification.
-
Parameters:
-
calling(Boolean): Indicates whether the API call was made. -
apiErrorCode(Number): The API error code (if available). -
numberValid(Boolean): Indicates whether the phone number is valid. -
apiErrorMsg(Text): The error message (if available).
-
Example:
blocksCopy code
When PhoneNumberVerify.SMSErrorOccurred(calling, apiErrorCode, numberValid, apiErrorMsg)
// Handle the SMS verification error here
End
3. SecurityCodeVerificationResult
- Description: Triggered when a security code verification is completed.
-
Parameters:
-
verified(Boolean): Indicates whether the security code is verified successfully.
-
Example:
blocksCopy code
When PhoneNumberVerify.SecurityCodeVerificationResult(verified)
// Handle the security code verification result here
End
Additional Notes
- Ensure that you have a valid API key and User ID before using this extension.
- You can obtain an API key and User ID by signing up for the Neutrino SMS Verify API.
- API is not free you can make 30 SMS free calls to test it before your free plan limit ended
- Check the official documentation of Neutrino API for more details on the API endpoints and response formats.
Download Extension
PhoneNumberVerify.aix (629.4 KB)
Donate
If you like this extension you can support me via PayPal
