Stop Subscription Service
You can link to this page to stop a subscription using the HTML
Form Post protocol. The table below shows the fields you can include in your
form. The fields marked with an asterisk (*) are mandatory.
| Authentication |
| Username* |
Your Esendex username, for example joe.bloggs@test.com |
| Password* |
Your Esendex password, for example joe1234 |
| Account* |
Your Esendex account reference, for example EX0000000 |
| |
|
MobileNumber
|
The mobile number subscribed to the subscription service.
|
| Other information |
| SuccessPage |
The URL to redirect to if the message is submitted successfully. If you omit
this field, an XML response is returned. |
| FailurePage |
The URL to redirect to if an error occurs when submitting the message. If you
omit this field, an XML response containing the message ID is returned. |
| Test |
Specify a value for the Test field to have this page redisplayed with the
values submitted by your form. This is for test purposes only, and no SMS
message will be sent. |
| PlainText |
Specify a value for this field to return plain text results instead of a
formatted HTML page.
For a successful request, results are in the format:
Result=OK
ContactId=value
where value is the the contact ID for the contact related to the subscription.
If the subscription relates to a non-contact for the account, an empty Guid is returned.
For an unsuccessful request, results are in the format:
Result=Error
Message=value
where Message value is a URL encoded description of the error.
|
Note: If any of the field names conflict with those in your existing HTML page,
prefix them with Esendex, for example (EsendexUserName).
The following examples are HTML pages you can use on your website: