Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pimvdnoll committed Nov 7, 2017
1 parent a2f4133 commit 78bdb25
Show file tree
Hide file tree
Showing 6 changed files with 109 additions and 22 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
deployment/*
.svn/*
.mendix-cache/*
Binary file modified CM NumberVerifier.mpr
Binary file not shown.
Empty file added CM NumberVerifier.mpr.lock
Empty file.
Binary file added Output/NumberVerifier-v-1-0-0.mpk
Binary file not shown.
93 changes: 71 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,83 @@
Description
-------------
-----------

Use this CM Demo application to test the CM SMS module and the CM Number Verifier module. After installing the application you will have a fully functional web app which you can use as an example for your own Mendix projects.
Number verification helps to keep your database clean, reduce human errors, improve the communication between you and your audience and reduce fraud risks. The number format validator is updated daily with new and changed number ranges globally. The number lookup performs a real-time lookup on the home carrier network.

#### Typical usage scenario
Number verification helps to keep your database clean, reduce human errors, improve the communication between you and your audience and reduce fraud risks.
Typical usage of Number Verification:
**Typical usage of Number Verification:**
Use Number format validation to

- Use Number validation to validate the user input for mobile or fixed numbers in web forms
- Use Number validation to categorize numbers in your database as mobile or fixed
- Use Number lookup to clean up your database and remove invalid or unavailable numbers
- Use Number lookup to prevent ATM card cloning fraud by checking the current location of a mobile number
- Validate the user input for mobile or fixed numbers in web forms
- Categorize numbers in your database as mobile or fixed

#### Features Number verifier
- Validate phone number format
- Check if a number is mobile, fixed, voip, and more
- Check if a number has a valid format
- Lookup mobile phone network
- Check if a mobile number is active or not
- Check if a mobile phone is roaming or not
- Check the time zone of the (roaming) country
**Use Mobile phone number network lookup to**

- Clean up your database and remove invalid or unavailable numbers
- Prevent ATM card cloning fraud by checking the current location of a mobile number

**Detailed feature overview**

Number format validation:

- See if a number has a valid format
- Valid (true/false)
- Get detailed information about the number (example)
- Country code (44)
- Country ISO (GB)
- Format e164 (+447911111111)
- Format international (+44 7911 111111)
- Format national (07911 111111)
- Region (Guernsey)
- Region code (GG)
- Time zone (Europe/London)
- Carrier (GB - Jersey Telecom – 23450)

- Get number type information (True/False)
- Is Mobile?
- Is Fixed line?
- Is Fixed line or mobile?
- Is Voip?
- Is Toll free?
- Is Voicemail?
- Is Emergency?
- Is Premium rate?
- Is Standard rate?
- Is Shared cost?
- Is Personal?
- Is Pager?
- Is Short code?
- Is Unknown?

**Mobile phone number network lookup:**

The same information as the number format validation

- See if the number is active
- Active number (true/false)
- Get information from the carrier network:
- Carrier mcc (234)
- Carrier mnc (50)
- Ported (true/false)
- Roaming (true/false)
- Get information from the roaming carrier network:
- Roaming country ISO (NL)
- Roaming country prefix (31)
- Roaming carrier (T-mobile)
- Roaming mcc (204)
- Roaming mnc (16)


#### Dependencies
- Mendix modeler 7.3.0 and above
- Rest services module


#### Installation and Configuration

- Set constant ProductToken for the module NumberVerifier with a token of the CM platform.
In case you don’t have a CM account yet, get one at [https://register.cmtelecom.com](https://register.cmtelecom.com) and get 10 test credits for free.
- Use the microflow `SUB_PhoneNumberLookup` and `SUB_PhoneNumberValidation`
In case you don’t have a CM account yet, get one at [https://register.cmtelecom.com](https://register.cmtelecom.com) and get 10 credits on top to send SMS for free. Get the CM Product token at [https://gateway.cmtelecom.com](https://gateway.cmtelecom.com) and store this key in the constant ProductToken of th eNumberVerifier module. You’re ready to go!
Use the microflow `SUB_PhoneNumberLookup` and `SUB_PhoneNumberValidation`

#### Demo
The CM Demo application allows you to test the SMS module and Number Verifier module of CM. The demo has both modules fully integrated in a fully functional app so you can actually test every functionality to see how it works.

#### Pricing
The Number format validator can be used for free in combination with a monthly subscription of other CM products. Without such subscription, a fee of 0.002 EUR per number query is charged.
For the Mobile phone network lookup a fee per transaction is applicable starting at 0.011 EUR depending on your total number of lookups per month. You will receive an addendum from CM about handling privacy sensitive information.
To start, share your use case along with an indication of the amount of lookups per month at [[email protected]](mailto:[email protected]) and get a customized offer.
36 changes: 36 additions & 0 deletions javasource/testmodule/proxies/microflows/Microflows.java
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,40 @@ public static void test_Mapping(IContext context)
throw new MendixRuntimeException(e);
}
}
public static void test_Verify(IContext context)
{
try
{
Map<java.lang.String, Object> params = new HashMap<java.lang.String, Object>();
Core.execute(context, "TestModule.Test_Verify", params);
}
catch (CoreException e)
{
throw new MendixRuntimeException(e);
}
}
public static void test_Verify_NOK(IContext context)
{
try
{
Map<java.lang.String, Object> params = new HashMap<java.lang.String, Object>();
Core.execute(context, "TestModule.Test_Verify_NOK", params);
}
catch (CoreException e)
{
throw new MendixRuntimeException(e);
}
}
public static void test_Verify_OK(IContext context)
{
try
{
Map<java.lang.String, Object> params = new HashMap<java.lang.String, Object>();
Core.execute(context, "TestModule.Test_Verify_OK", params);
}
catch (CoreException e)
{
throw new MendixRuntimeException(e);
}
}
}

0 comments on commit 78bdb25

Please sign in to comment.