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

sms - getlists

Gets a list of the lists in the account.


API Call Information
area: sms
action: getlists

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=getlists

API Result:
XML Response JSON Response
<response>
  <records>21</records>
  <list>
    <id>2</id>
    <title><![CDATA[test]]></title>
    <status/>
    <statusint>0</statusint>
    <total/>
    <active/>
    <datecreated>March 21, 2021, 06:39 pm</datecreated>
    <isfolder>1</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>0B</filesize>
  </list>
  <list>
    <id>195</id>
    <title><![CDATA[mobile23.csv]]></title>
    <status/>
    <statusint>0</statusint>
    <total>21321</total>
    <active>18859</active>
    <datecreated>March 12, 2024, 12:49 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>11MB</filesize>
  </list>
  <list>
    <id>136</id>
    <title><![CDATA[malik]]></title>
    <status/>
    <statusint>0</statusint>
    <total>2</total>
    <active>2</active>
    <datecreated>February 15, 2024, 10:15 am</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>160kB</filesize>
  </list>
  <list>
    <id>134</id>
    <title><![CDATA[first 10 of HD 67 DAREN MEIS.csv - (non matching)]]></title>
    <status/>
    <statusint>0</statusint>
    <total>10</total>
    <active>10</active>
    <datecreated>February 08, 2024, 10:37 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>1</leased>
    <locked>0</locked>
    <filesize>0B</filesize>
  </list>
  <list>
    <id>133</id>
    <title><![CDATA[first 10 of HD 67 DAREN MEIS.csv - (matching)]]></title>
    <status/>
    <statusint>0</statusint>
    <total>1</total>
    <active>1</active>
    <datecreated>February 08, 2024, 10:37 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>0B</filesize>
  </list>
  <list>
    <id>132</id>
    <title><![CDATA[first 10 of HD 67 DAREN MEIS.csv - (matching)]]></title>
    <status/>
    <statusint>0</statusint>
    <total>1</total>
    <active>1</active>
    <datecreated>February 08, 2024, 10:34 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>0B</filesize>
  </list>
  <list>
    <id>131</id>
    <title><![CDATA[first 10 of HD 67 DAREN MEIS.csv - (matching)]]></title>
    <status>Split creating match file</status>
    <statusint>247</statusint>
    <total/>
    <active/>
    <datecreated>February 08, 2024, 10:32 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>0B</filesize>
  </list>
  <list>
    <id>130</id>
    <title><![CDATA[first 10 of HD 67 DAREN MEIS.csv - (matching)]]></title>
    <status>Split creating match file</status>
    <statusint>247</statusint>
    <total/>
    <active/>
    <datecreated>February 08, 2024, 10:27 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>0B</filesize>
  </list>
  <list>
    <id>124</id>
    <title><![CDATA[first 10 of HD 67 DAREN MEIS.csv]]></title>
    <status/>
    <statusint>0</statusint>
    <total>11</total>
    <active>11</active>
    <datecreated>February 06, 2024, 10:45 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>160kB</filesize>
  </list>
  <list>
    <id>116</id>
    <title><![CDATA[cell phone second]]></title>
    <status/>
    <statusint>0</statusint>
    <total>20892</total>
    <active>20892</active>
    <datecreated>February 06, 2024, 03:35 pm</datecreated>
    <isfolder>0</isfolder>
    <optinlist>0</optinlist>
    <suppressionlist>0</suppressionlist>
    <suppressionmd5>0</suppressionmd5>
    <leased>0</leased>
    <locked>0</locked>
    <filesize>7MB</filesize>
  </list>
</response>		 
{
    "records": "21",
    "list": [
        {
            "id": "2",
            "title": "test",
            "status": "",
            "statusint": "0",
            "total": "",
            "active": "",
            "datecreated": "March 21, 2021, 06:39 pm",
            "isfolder": "1",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "0B"
        },
        {
            "id": "195",
            "title": "mobile23.csv",
            "status": "",
            "statusint": "0",
            "total": "21321",
            "active": "18859",
            "datecreated": "March 12, 2024, 12:49 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "11MB"
        },
        {
            "id": "136",
            "title": "malik",
            "status": "",
            "statusint": "0",
            "total": "2",
            "active": "2",
            "datecreated": "February 15, 2024, 10:15 am",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "160kB"
        },
        {
            "id": "134",
            "title": "first 10 of HD 67 DAREN MEIS.csv - (non matching)",
            "status": "",
            "statusint": "0",
            "total": "10",
            "active": "10",
            "datecreated": "February 08, 2024, 10:37 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "1",
            "locked": "0",
            "filesize": "0B"
        },
        {
            "id": "133",
            "title": "first 10 of HD 67 DAREN MEIS.csv - (matching)",
            "status": "",
            "statusint": "0",
            "total": "1",
            "active": "1",
            "datecreated": "February 08, 2024, 10:37 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "0B"
        },
        {
            "id": "132",
            "title": "first 10 of HD 67 DAREN MEIS.csv - (matching)",
            "status": "",
            "statusint": "0",
            "total": "1",
            "active": "1",
            "datecreated": "February 08, 2024, 10:34 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "0B"
        },
        {
            "id": "131",
            "title": "first 10 of HD 67 DAREN MEIS.csv - (matching)",
            "status": "Split creating match file",
            "statusint": "247",
            "total": "",
            "active": "",
            "datecreated": "February 08, 2024, 10:32 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "0B"
        },
        {
            "id": "130",
            "title": "first 10 of HD 67 DAREN MEIS.csv - (matching)",
            "status": "Split creating match file",
            "statusint": "247",
            "total": "",
            "active": "",
            "datecreated": "February 08, 2024, 10:27 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "0B"
        },
        {
            "id": "124",
            "title": "first 10 of HD 67 DAREN MEIS.csv",
            "status": "",
            "statusint": "0",
            "total": "11",
            "active": "11",
            "datecreated": "February 06, 2024, 10:45 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "160kB"
        },
        {
            "id": "116",
            "title": "cell phone second",
            "status": "",
            "statusint": "0",
            "total": "20892",
            "active": "20892",
            "datecreated": "February 06, 2024, 03:35 pm",
            "isfolder": "0",
            "optinlist": "0",
            "suppressionlist": "0",
            "suppressionmd5": "0",
            "leased": "0",
            "locked": "0",
            "filesize": "7MB"
        }
    ]
}