HyperMail.com
Call us toll free @ 888-497-7898
HyperMail.com
Call us toll free @ 888.497.7898

sms - getunsubscribelist

Gets a list of mobile numbers that have unsubscribed


API Call Information
area: sms
action: getunsubscribelist

API Arguments
Argument Data Type Required Description
start integer No Starting position of number of records
limit integer No Number of records to return
API Url Example:
https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=sms&action=getunsubscribelist

API Result:
XML Response JSON Response
<response>
  <records>1</records>
  <optout>
    <id>342</id>
    <mobile>1235200572</mobile>
    <datecreated><![CDATA[October 16, 2024, 04:53 pm]]></datecreated>
    <campaignid>0</campaignid>
  </optout>
</response>		 
{
    "records": "1",
    "optout": {
        "id": "342",
        "mobile": "1235200572",
        "datecreated": "October 16, 2024, 04:53 pm",
        "campaignid": "0"
    }
}