sms - getcampaigns

API Call Information

area: sms

action: getcampaigns

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

API Response

XML Response

<response>

  <records>878</records>

  <campaign>

    <id>525</id>

    <title><![CDATA[test]]></title>

    <status>Draft</status>

    <statusint>10</statusint>

    <scheduledate>October 28, 2024, 10:30 am</scheduledate>

    <starttime/>

    <endtime/>

    <lastupdate/>

    <sent>0</sent>

    <pendingsend>0</pendingsend>

    <clicks>1</clicks>

    <uniqueclicks>0</uniqueclicks>

    <replies>0</replies>

    <optouts>0</optouts>

    <totalconverstations>0</totalconverstations>

    <totalcontacts>0</totalcontacts>

    <smscredits>0</smscredits>

    <mmscredits>0</mmscredits>

  </campaign>

  <campaign>

    <id>113</id>

    <title><![CDATA[Malik Survey/Poll Campaign]]></title>

    <status>Completed</status>

    <statusint>900</statusint>

    <scheduledate>February 15, 2024, 10:15 am</scheduledate>

    <starttime>February 15, 2024, 10:18 am</starttime>

    <endtime>February 15, 2024, 10:19 am</endtime>

    <lastupdate/>

    <sent>1</sent>

    <pendingsend>0</pendingsend>

    <clicks>0</clicks>

    <uniqueclicks>0</uniqueclicks>

    <replies>8</replies>

    <optouts>0</optouts>

    <totalconverstations>0</totalconverstations>

    <totalcontacts>1</totalcontacts>

    <smscredits>1</smscredits>

    <mmscredits>0</mmscredits>

  </campaign>

  <campaign>

    <id>6</id>

    <title><![CDATA[test]]></title>

    <status>Completed</status>

    <statusint>900</statusint>

    <scheduledate>January 12, 2024, 07:11 pm</scheduledate>

    <starttime>November 12, 2023, 07:12 pm</starttime>

    <endtime>February 10, 2024, 04:04 pm</endtime>

    <lastupdate/>

    <sent>1</sent>

    <pendingsend>0</pendingsend>

    <clicks>0</clicks>

    <uniqueclicks>0</uniqueclicks>

    <replies>7</replies>

    <optouts>0</optouts>

    <totalconverstations>0</totalconverstations>

    <totalcontacts>1</totalcontacts>

    <smscredits>1</smscredits>

    <mmscredits>0</mmscredits>

  </campaign>

  <campaign>

    <id>4</id>

    <title><![CDATA[Dev Test Campaign]]></title>

    <status>Completed</status>

    <statusint>900</statusint>

    <scheduledate>November 03, 2023, 04:21 pm</scheduledate>

    <starttime>November 03, 2023, 04:32 pm</starttime>

    <endtime>November 05, 2023, 09:03 am</endtime>

    <lastupdate/>

    <sent>2</sent>

    <pendingsend>0</pendingsend>

    <clicks>2</clicks>

    <uniqueclicks>0</uniqueclicks>

    <replies>4</replies>

    <optouts>0</optouts>

    <totalconverstations>0</totalconverstations>

    <totalcontacts>1</totalcontacts>

    <smscredits>0</smscredits>

    <mmscredits>0</mmscredits>

  </campaign>

  <campaign>

    <id>1</id>

    <title><![CDATA[test cmpaign Dev]]></title>

    <status>Completed</status>

    <statusint>900</statusint>

    <scheduledate>October 03, 2023, 12:18 pm</scheduledate>

    <starttime/>

    <endtime>October 21, 2023, 08:57 pm</endtime>

    <lastupdate/>

    <sent>0</sent>

    <pendingsend>0</pendingsend>

    <clicks>3</clicks>

    <uniqueclicks>0</uniqueclicks>

    <replies>0</replies>

    <optouts>0</optouts>

    <totalconverstations>0</totalconverstations>

    <totalcontacts>984242</totalcontacts>

    <smscredits>0</smscredits>

    <mmscredits>0</mmscredits>

  </campaign>

</response>

JSON Response

{
    "records": "878",
    "campaign": [
        {
            "id": "525",
            "title": "test",
            "status": "Draft",
            "statusint": "10",
            "scheduledate": "October 28, 2024, 10:30 am",
            "starttime": "",
            "endtime": "",
            "lastupdate": "",
            "sent": "0",
            "pendingsend": "0",
            "clicks": "1",
            "uniqueclicks": "0",
            "replies": "0",
            "optouts": "0",
            "totalconverstations": "0",
            "totalcontacts": "0",
            "smscredits": "0",
            "mmscredits": "0"
        },
        {
            "id": "113",
            "title": "Malik Survey/Poll Campaign",
            "status": "Completed",
            "statusint": "900",
            "scheduledate": "February 15, 2024, 10:15 am",
            "starttime": "February 15, 2024, 10:18 am",
            "endtime": "February 15, 2024, 10:19 am",
            "lastupdate": "",
            "sent": "1",
            "pendingsend": "0",
            "clicks": "0",
            "uniqueclicks": "0",
            "replies": "8",
            "optouts": "0",
            "totalconverstations": "0",
            "totalcontacts": "1",
            "smscredits": "1",
            "mmscredits": "0"
        },
        {
            "id": "6",
            "title": "test",
            "status": "Completed",
            "statusint": "900",
            "scheduledate": "January 12, 2024, 07:11 pm",
            "starttime": "November 12, 2023, 07:12 pm",
            "endtime": "February 10, 2024, 04:04 pm",
            "lastupdate": "",
            "sent": "1",
            "pendingsend": "0",
            "clicks": "0",
            "uniqueclicks": "0",
            "replies": "7",
            "optouts": "0",
            "totalconverstations": "0",
            "totalcontacts": "1",
            "smscredits": "1",
            "mmscredits": "0"
        },
        {
            "id": "4",
            "title": "Dev Test Campaign",
            "status": "Completed",
            "statusint": "900",
            "scheduledate": "November 03, 2023, 04:21 pm",
            "starttime": "November 03, 2023, 04:32 pm",
            "endtime": "November 05, 2023, 09:03 am",
            "lastupdate": "",
            "sent": "2",
            "pendingsend": "0",
            "clicks": "2",
            "uniqueclicks": "0",
            "replies": "4",
            "optouts": "0",
            "totalconverstations": "0",
            "totalcontacts": "1",
            "smscredits": "0",
            "mmscredits": "0"
        },
        {
            "id": "1",
            "title": "test cmpaign Dev",
            "status": "Completed",
            "statusint": "900",
            "scheduledate": "October 03, 2023, 12:18 pm",
            "starttime": "",
            "endtime": "October 21, 2023, 08:57 pm",
            "lastupdate": "",
            "sent": "0",
            "pendingsend": "0",
            "clicks": "3",
            "uniqueclicks": "0",
            "replies": "0",
            "optouts": "0",
            "totalconverstations": "0",
            "totalcontacts": "984242",
            "smscredits": "0",
            "mmscredits": "0"
        }
    ]
}