If you have your own system and would like to create a lead 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.
The API will create the list then it will respond with the new list xml
Url: https://mcpn.us/limeApi?ev=createLeadList
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 |
None |
|
api_id |
Advertiser Api Id |
The advertiser’s api_id that matches the username |
Generated from edit profile |
|
name |
List name |
List name |
|
|
keyword |
Text |
Provide a custom keyword. Leave blank in order to create and use a random keyword |
|
|
shortcode |
Full short code (71441-US / 71441-Ca / 40691 / 60222 ...) |
Applicable only for accounts that having more than one short code. |
|
|
message |
Text |
The message that will be replied to the mobile number after he texted the keyword |
|
|
isProfileGraber |
true/false |
Indicate if profile grabber is enabled for this list. |
false |
|
sendToMyEmail |
true/false |
Indicate if send an email to your email address (on your profile) when a new lead is registered |
false |
|
notifyEmail |
|
Email address that will be notified when a new lead is registered |
none |
|
notifyNumber |
Mobile Number |
Mobile number/s address that will be notified when a new lead is registered, can be multiple numbers separated by a semicolon |
none |
|
couponId |
Number |
Coupon id that will be send after opt-in |
none |
|
alternativeAutoReply |
Text |
Auto reply message if the user try to text to the list more than once. |
|
|
responseUrl |
Text |
A url on your server that will be called upon action in the list. Please refer to the API document: "Lead Generation List Keyword to Response URL" |
|
|
responseUrlMethod |
GET/POST |
Indicate the method of the response url must be GET/POST |
GET |
|
isWaitResponseUrl |
true/false |
Indicates if need to wait for OK message from the response URL before sending the reply to the mobile |
false |
|
adfEmail |
|
Address to send an Email with ADF format upon new lead |
|
Return Code
If the API succeeds then it will return with status code 200 with the following XML:
<listing>
<id>1453</id>
<name>Web Site</name>
<keyword>zm85 (71441-US)</keyword>
<message>
Thank you for contacting us! One of our representatives will call you back shortly.
</message>
<profileGrabber>false</profileGrabber>
<alternativeReply/>
<responseUrl></responseUrl>
<responseUrlMethod></responseUrlMethod>
<waitForOK>false</waitForOK>
<adfEmail/>
<coupon>25672</coupon>
<sendToMyEmail>true</sendToMyEmail>
<notifyEmail/>
<notifyNumber/>
</listing>
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=createLeadList&user=testuserguy&api_id=bjHI73WyLV83822C&name=Lead List&keyword=Keyword1&shortcode=71441-US&message=Response message&couponId=33167&alternativeAutoReply=alternative message reply&sendToMyEmail=true¬ifyEmail=test@gmail.com¬ifyNumber=15555555555&responseUrl=http://test.com/response&responseUrlMethod=POST&isWaitResponseUrl=true
Comments
0 comments
Article is closed for comments.