Mobile Lookup API
If you have your own system and would like to check if a mobile number is valid and supported without our dashboard, we have just created an API allowing you to do just that. This API is for server-to-server communication, in case you have your own CRM system or something similar to manage your customer base.
Each call to the API will be charged one credit when used by advertisers or administrators.
Url: https://mcpn.us/limeApi?ev=mobileLookup
You must supply all of the following parameters
Parameters (case sensitive, bold are mandatory):
Parameter Name (Case Sensitive)
|
Value |
Description |
Default Value |
user |
Advertiser username |
The advertiser’s username that matches the api_id and own the loyalty program |
None |
api_id |
Advertiser Api Id |
The Advertiser's api_id that matches the username |
Generated from edit profile |
mobile |
String |
The mobile number to check |
|
format |
String |
If equal to "json" then the return will be a detailed JSON object |
No json |
Return Code
If the API succeeds and the mobile is valid, then it will return with status code 200 and "OK Mobile: xxx is valid" message in the body.
If the parameter "format" supplied with the value: "json" the return will be with code 200 and in the body will be the following JSON:
{
" isValid", true,
" carrierName":"carrier name",
"carrierId": id,
"smsSurcharge": surcharge for sms,
"mmsSurcharge": surcharge for mms
}
If an error occurs or there is an invalid parameter, then it returns with status code 403 or 400 or 500 with an error message in the response body.
Example:
https://mcpn.us/limeApi?ev=mobileLookup&user=advertiseruser&api_id=a5SNH43WyAA83SWLK&mobile=15555555555
Comments
0 comments
Article is closed for comments.