Opt-in List Keyword to Response URL
If you set a response URL on your opt-in list notifications, the system will call this URL for every keyword texting to this opt-in list or when a mobile number is opted-out from this opt-in list.
- When a mobile device texts a keyword to the lead list and a response URL is given, then the response will be sent to your response URL with an HTTP GET or POST method (According to the method that is selected) with the following parameters:
Parameter Name
|
Value |
Description |
|
action |
optin/optout/optout-all/update |
|
|
list_id |
Opt-in list Id |
The opt-in list id that the mobile opt-in/opt-out |
|
mobile_number |
Mobile number |
The mobile number that opt-in/opt-out |
|
keyword (optional) |
Keyword |
The keyword that the mobile text to opt-in or opt-out, if the user sent STOP ALL than these parameters is not supplied |
|
data (optional) |
Text (URL Encoded UTF-8) |
If after the keyword the mobile number added an extra text then this text is sent to the url |
|
isNewOptIn |
true/false |
If opt-in, this indicates if this is new opt-in or not |
|
firstName |
First Name |
Submit user's First Name if value exists |
|
lastName |
Last Name |
Submit user's Last Name if value exists |
|
gender |
M/F |
Submit user's Gender if value exists |
|
dob |
MM/dd/yyyy |
Submit user's Date of Birth if value exists |
|
|
|
Submit user's Email if value exists |
|
familyStatus |
Single/Married |
Submit user's Marital Status if value exists |
|
numKids |
Number |
Submit user's Number of Kids if value exists |
|
zipcode |
String |
Submit user's Zipcode if value exists |
|
userDefine1 |
String |
Submit User-defined/Custom field 1 data if value exists |
|
userDefine2 |
String |
Submit User-defined/Custom field 2 data if value exists |
|
userDefine3 |
String |
Submit User-defined/Custom field 3 data if value exists |
|
userDefine4 |
String |
Submit User-defined/Custom field 4 data if value exists |
|
userDefine5 |
String |
Submit User-defined/Custom field 5 data if value exists |
|
userDefine6 |
String |
Submit User-defined/Custom field 6 date if value exists |
|
userDefine7 |
String |
Submit User-defined/Custom field 7 date if value exists |
|
carrier |
Text |
Carrier Name |
Example: If the opt-in list is assigned to the keyword PIZZA and has the response URL set to: http://yourcompany.com/api.
When a mobile number (ex: 15555555555) texts PIZZA to the short code, then the response URL will be:
http://yourcompany.com/api?action=optin&list_id=1221&mobile_number=15555555555&keyword=PIZZA
When a mobile number ( ex: 15555555555) opts-out from the list then the response URL will be:
http://yourcompany.com/api?action=optout&list_id=1221&mobile_number=15555555555&keyword=PIZZA
When a mobile number 15555555555 texts STOP ALL and opt-out from all lists then the response url will be:
http://yourcompany.com/api?action=optout-all&list_id=1221&mobile_number=15555555555
Comments
0 comments
Article is closed for comments.