Opted In Numbers API
If you have your own system and would like to get your opted-in numbers in a specific opt-in list 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.
Url: https://mcpn.us/limeApi?ev=optedInNumbers
Supply 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 |
optInListId |
Number |
Opt-in list ID |
|
isOnlyNumbers |
True/false |
Set to true will return only mobile numbers without more details <MobileNumber> only in the XML. |
false |
isWalletUrl |
True/false |
Set to true will return only wallet url without more details <WalletUrl> only in the XML. |
false |
Return Code
If the API succeeds, then it will return with status code 200 with xml
If an error occurs or there is an invalid parameter, then it returns with status code 400 or 500 with an error message in the response.
Example:
https://mcpn.us/limeApi?ev=optedInNumbers?user=advertiseruser&api_id=a5SNH43WyAA83SWLK& optInListId=1112
XML Response:
<?xml version="1.0" ?>
<Mobiles>
<Mobile>
<MobileNumber>173255555555</MobileNumber>
<OptInDate>01/17/2012 01:08:21 AM</OptInDate>
<FirstName>Jhon</FirstName>
<LastName>Doe</LastName>
<Gender>M</Gender>
<DateOfBirth>01/01/1991</DateOfBirth>
<Email>mobile@gmail.com</Email>
<Zipcode>98765</Zipcode>
<Keyword>PIZZA (71441-US)</Keyword>
<ShortCode>71441</ShortCode>
<UserDefine1>UA153366</UserDefine1>
<UserDefine2></UserDefine2>
<UserDefine3></UserDefine3>
<UserDefine4></UserDefine4>
<UserDefine5></UserDefine5>
<UserDefine6></UserDefine6>
<UserDefine7>10/06/2007 03:00:00 PM</UserDefine7>
<WalletUrl>https://url.com</WalletUrl>
</Mobile>
<Mobile>
<MobileNumber>7322555555</MobileNumber>
<OptInDate>11/14/2016 04:25:43 PM</OptInDate>
<FirstName>Jane</FirstName>
<LastName>Doe</LastName>
<Gender>F</Gender>
<DateOfBirth>07/31/1975</DateOfBirth>
<Email>test@gmail.com</Email>
<Zipcode>52364</Zipcode>
<Keyword>PIZZA (71441-US)</Keyword>
<ShortCode>71441</ShortCode>
<UserDefine1></UserDefine1>
<UserDefine2></UserDefine2>
<UserDefine3></UserDefine3>
<UserDefine4></UserDefine4>
<UserDefine5></UserDefine5>
<UserDefine6></UserDefine6>
<UserDefine7></UserDefine7>
<WalletUrl>https://url.com</WalletUrl>
</Mobile>
</Mobiles>
Comments
0 comments
Please sign in to leave a comment.