...
URL: http://newsletter.domainname.tld/frontend/xmlSubscribe.aspx (replace the part marked in red with the actual third level domain)
INPUT PARAMETERS AT ENTRANCE:
Name | Mandatory? | Description |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
List | Y | List ID |
Group | N | Groups to which to subscribe the user |
Confirm | N | Parameter to enable or disable confirmation request email. Accepted values: 0/1. Default value: 1 |
csvFldNames | N | Personal data codes (separated by ";" character) |
csvFldValues | N | Values related to personal data codes (separated by ";" character) |
retCode | N | Parameter to enable or disable the return of an output code for the call. Accepted values: 0/1 – Default value: 0 |
Dynsndmail(3) | N | "dynamic sender e-mail address" Sender address in the confirmation request email (If blank, default value for the list will be used) |
dynsndname(3) | N | "dynamic sender name" Sender name in the confirmation request email (If blank, default value for the list will be used) |
(1) either email or sms parameter must be specified
(2) if blank, international code for Italy will be used (0039)
(3) for further details on how to use these fields, please see the section about the "subscribe.aspx" function
OUTPUT RETURNED VALUES:
CODE | DESCRIPTION |
0 | Operation completed successfully |
1 | Generic error |
2 | Invalid email address or mobile number |
3 | User already subscribed |
...
Xmlchksubscriber.aspx (User subscription check)
This function performs a check on a user subscription status
URL: http://newsletter.domainname.tld/frontend/xmlChkSubscriber.aspx
INPUT PARAMETERS AT ENTRANCE:
Name | Mandatory? | Description |
ListGuid | Y | Alphanumeric code associated to a distribution list |
List | Y | List ID |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
(1) either email or sms parameter must be specified
(2) if blank, international code for Italy will be used (0039)
OUTPUT RETURNED VALUES:
CODE | DESCRIPTION |
1 | Generic error / user not subscribed |
2 | User subscribed (OPT-IN) |
3 | User unsubscribed (OPT-OUT) |
4 | User subscription to be confirmed (PENDING) |
NOTE:
Code 1 is given as output value both in case of error (e.g. when ListGuid code does not match ListID) and when the user is not subscribed.
...
URL: http://newsletter.domainname.tld/frontend/xmlUnSubscribe.aspx
INPUT PARAMETERS AT ENTRANCE:
Name | Mandatory? | Description |
ListGuid | Y | Alphanumeric code associated to a distribution list |
List | Y | List ID |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
(1) either email or sms parameter must be specified
(2) if blank, international code for Italy will be used (0039)
OUTPUT RETURNED VALUES:
CODE | DESCRIPTION |
0 | User unsubscribed successfully |
1 | Generic error |
3 | User unknown / already unsubscribed |
...
This function allows to update a user's personal data.
URL: http://newsletter.domainname.tld/frontend/xmlUpdSubscriber.aspx
INPUT PARAMETERS AT ENTRANCE:
Name | Mandatory? | Description |
ListGuid | Y | Alphanumeric code associated to a distribution list |
List | Y | List ID |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
Replace | N | Parameter to enable or disable group replacement for the specified user. Accepted values: 0/1/false/true – Default value: false |
Group | N | Groups to which to subscribe the user |
csvFldNames | N | Personal data codes (separated by ";" character) |
csvFldValues | N | Values related to personal data codes (separated by ";" character) |
(1) either email or sms parameter must be specified
(2) if blank, international code for Italy will be used (0039)
OUTPUT RETURNED VALUES:
CODE | DESCRIPTION |
0 | Data updated successfully |
1 | Generic error |