GET api/smscampaignreport/{id}/Unsubscribed?SendType={SendType}&SearchTerm={SearchTerm}&RowsAffected={RowsAffected}&PreviousRowCount={PreviousRowCount}&FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}

Back

For more information on using API

GET http://webapi.mymarketing.co.il/api/smscampaignreport/{id}/Unsubscribed?SendType={SendType}&SearchTerm={SearchTerm}&RowsAffected={RowsAffected}&PreviousRowCount={PreviousRowCount}&FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}

Request Information

URI Parameters

Name

Description

Type

Additional information

integer

Required

send_type

integer

search_term

string

rows_affected

integer

previous_row_count

integer

from_date

The first date the contacts you want were created

date

to_date

The last date the contacts you want were created.(Default values is 3 last months)

date

page

Get a specific page (number of pages is limited)

integer

Range: inclusive between 1 and 2147483647

limit

Limit the number of items you get in the results.

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

ApiContactsList

Name

Description

Type

Additional information

count

List count

integer

contacts

see ContactContainerItem

Collection of ContactContainerItem

Response Formats

application/json, text/json

Sample:

{
  "count": 1,
  "contacts": [
    {
      "id": 1,
      "state": "Unsubscribed",
      "is_optined": true,
      "email": "sample string 4",
      "sms": "sample string 5",
      "first_name": "sample string 6",
      "last_name": "sample string 7",
      "anniversary": "2016-12-24T14:12:12",
      "birthday": "2016-12-24T14:12:12",
      "city": "sample string 8",
      "fax": "sample string 9",
      "phone1": "sample string 10",
      "phone2": "sample string 11",
      "street": "sample string 12",
      "zip_code": "sample string 13",
      "ext1": "sample string 14",
      "ext2": "sample string 15",
      "ext3": "sample string 16",
      "ext4": "sample string 17",
      "ext5": "sample string 18",
      "ext6": "sample string 19",
      "ext7": "sample string 20",
      "ext8": "sample string 21",
      "ext9": "sample string 22",
      "ext10": "sample string 23",
      "ext11": "sample string 24",
      "ext12": "sample string 25",
      "ext13": "sample string 26",
      "ext14": "sample string 27",
      "ext15": "sample string 28",
      "ext16": "sample string 29",
      "ext17": "sample string 30",
      "ext18": "sample string 31",
      "ext19": "sample string 32",
      "ext20": "sample string 33",
      "ext21": "sample string 34",
      "ext22": "sample string 35",
      "ext23": "sample string 36",
      "ext24": "sample string 37",
      "ext25": "sample string 38",
      "date1": "2016-12-24T14:12:12",
      "date2": "2016-12-24T14:12:12",
      "date3": "2016-12-24T14:12:12",
      "date4": "2016-12-24T14:12:12",
      "date5": "2016-12-24T14:12:12",
      "num1": 1,
      "num2": 1,
      "num3": 1,
      "num4": 1,
      "num5": 1,
      "is_do_not_mail": true,
      "is_deleted": true
    },
    {
      "id": 1,
      "state": "Unsubscribed",
      "is_optined": true,
      "email": "sample string 4",
      "sms": "sample string 5",
      "first_name": "sample string 6",
      "last_name": "sample string 7",
      "anniversary": "2016-12-24T14:12:12",
      "birthday": "2016-12-24T14:12:12",
      "city": "sample string 8",
      "fax": "sample string 9",
      "phone1": "sample string 10",
      "phone2": "sample string 11",
      "street": "sample string 12",
      "zip_code": "sample string 13",
      "ext1": "sample string 14",
      "ext2": "sample string 15",
      "ext3": "sample string 16",
      "ext4": "sample string 17",
      "ext5": "sample string 18",
      "ext6": "sample string 19",
      "ext7": "sample string 20",
      "ext8": "sample string 21",
      "ext9": "sample string 22",
      "ext10": "sample string 23",
      "ext11": "sample string 24",
      "ext12": "sample string 25",
      "ext13": "sample string 26",
      "ext14": "sample string 27",
      "ext15": "sample string 28",
      "ext16": "sample string 29",
      "ext17": "sample string 30",
      "ext18": "sample string 31",
      "ext19": "sample string 32",
      "ext20": "sample string 33",
      "ext21": "sample string 34",
      "ext22": "sample string 35",
      "ext23": "sample string 36",
      "ext24": "sample string 37",
      "ext25": "sample string 38",
      "date1": "2016-12-24T14:12:12",
      "date2": "2016-12-24T14:12:12",
      "date3": "2016-12-24T14:12:12",
      "date4": "2016-12-24T14:12:12",
      "date5": "2016-12-24T14:12:12",
      "num1": 1,
      "num2": 1,
      "num3": 1,
      "num4": 1,
      "num5": 1,
      "is_do_not_mail": true,
      "is_deleted": true
    }
  ]
}

application/xml, text/xml

Sample:

<ApiContactsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <contacts>
    <ContactContainerItem>
      <anniversary>2016-12-24T14:12:12</anniversary>
      <birthday>2016-12-24T14:12:12</birthday>
      <city>sample string 8</city>
      <date1>2016-12-24T14:12:12</date1>
      <date2>2016-12-24T14:12:12</date2>
      <date3>2016-12-24T14:12:12</date3>
      <date4>2016-12-24T14:12:12</date4>
      <date5>2016-12-24T14:12:12</date5>
      <email>sample string 4</email>
      <ext1>sample string 14</ext1>
      <ext10>sample string 23</ext10>
      <ext11>sample string 24</ext11>
      <ext12>sample string 25</ext12>
      <ext13>sample string 26</ext13>
      <ext14>sample string 27</ext14>
      <ext15>sample string 28</ext15>
      <ext16>sample string 29</ext16>
      <ext17>sample string 30</ext17>
      <ext18>sample string 31</ext18>
      <ext19>sample string 32</ext19>
      <ext2>sample string 15</ext2>
      <ext20>sample string 33</ext20>
      <ext21>sample string 34</ext21>
      <ext22>sample string 35</ext22>
      <ext23>sample string 36</ext23>
      <ext24>sample string 37</ext24>
      <ext25>sample string 38</ext25>
      <ext3>sample string 16</ext3>
      <ext4>sample string 17</ext4>
      <ext5>sample string 18</ext5>
      <ext6>sample string 19</ext6>
      <ext7>sample string 20</ext7>
      <ext8>sample string 21</ext8>
      <ext9>sample string 22</ext9>
      <fax>sample string 9</fax>
      <first_name>sample string 6</first_name>
      <is_deleted>true</is_deleted>
      <is_do_not_mail>true</is_do_not_mail>
      <last_name>sample string 7</last_name>
      <num1>1</num1>
      <num2>1</num2>
      <num3>1</num3>
      <num4>1</num4>
      <num5>1</num5>
      <phone1>sample string 10</phone1>
      <phone2>sample string 11</phone2>
      <sms>sample string 5</sms>
      <street>sample string 12</street>
      <zip_code>sample string 13</zip_code>
    </ContactContainerItem>
    <ContactContainerItem>
      <anniversary>2016-12-24T14:12:12</anniversary>
      <birthday>2016-12-24T14:12:12</birthday>
      <city>sample string 8</city>
      <date1>2016-12-24T14:12:12</date1>
      <date2>2016-12-24T14:12:12</date2>
      <date3>2016-12-24T14:12:12</date3>
      <date4>2016-12-24T14:12:12</date4>
      <date5>2016-12-24T14:12:12</date5>
      <email>sample string 4</email>
      <ext1>sample string 14</ext1>
      <ext10>sample string 23</ext10>
      <ext11>sample string 24</ext11>
      <ext12>sample string 25</ext12>
      <ext13>sample string 26</ext13>
      <ext14>sample string 27</ext14>
      <ext15>sample string 28</ext15>
      <ext16>sample string 29</ext16>
      <ext17>sample string 30</ext17>
      <ext18>sample string 31</ext18>
      <ext19>sample string 32</ext19>
      <ext2>sample string 15</ext2>
      <ext20>sample string 33</ext20>
      <ext21>sample string 34</ext21>
      <ext22>sample string 35</ext22>
      <ext23>sample string 36</ext23>
      <ext24>sample string 37</ext24>
      <ext25>sample string 38</ext25>
      <ext3>sample string 16</ext3>
      <ext4>sample string 17</ext4>
      <ext5>sample string 18</ext5>
      <ext6>sample string 19</ext6>
      <ext7>sample string 20</ext7>
      <ext8>sample string 21</ext8>
      <ext9>sample string 22</ext9>
      <fax>sample string 9</fax>
      <first_name>sample string 6</first_name>
      <is_deleted>true</is_deleted>
      <is_do_not_mail>true</is_do_not_mail>
      <last_name>sample string 7</last_name>
      <num1>1</num1>
      <num2>1</num2>
      <num3>1</num3>
      <num4>1</num4>
      <num5>1</num5>
      <phone1>sample string 10</phone1>
      <phone2>sample string 11</phone2>
      <sms>sample string 5</sms>
      <street>sample string 12</street>
      <zip_code>sample string 13</zip_code>
    </ContactContainerItem>
  </contacts>
  <count>1</count>
</ApiContactsList>

GET http://webapi.mymarketing.co.il/api/smscampaignreport/{id}/Unsubscribed?SendType={SendType}&SearchTerm={SearchTerm}&RowsAffected={RowsAffected}&PreviousRowCount={PreviousRowCount}&FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body