For more information on using API

GET http://webapi.mymarketing.co.il/api/smscampaign/Campaign?IsIncludeNotSent={IsIncludeNotSent}&FromDate={FromDate}&ToDate={ToDate}&SearchTerm={SearchTerm}&FilterType={FilterType}&Page={Page}&Limit={Limit}

Get SMS campaigns. You can get sms campaigns filtered (you will get the last 20 campaigns in the last 6 months by default)

Request Information

URI Parameters

Name

Description

Type

Additional information

isIncludeNotSent

boolean
fromDate

date
toDate

date
searchTerm

string
filterType

integer
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

ApiSmsCampaignInfoCampaignList

Name

Description

Type

Additional information

sms_campaign

List of SMS campaign

Collection of ApiSmsCampaignInfoCampaign
total_items

Total number of SMS campaign

integer

Response Formats

application/json, text/json

Sample: 
{
  "sms_campaign": [
    {
      "send_type": "Regular",
      "send_type_name": "sample string 1",
      "status_id": 2,
      "status_name": "sample string 3",
      "total_sent": 4,
      "status_date": "2016-12-24T14:12:12",
      "handled_date": "2016-12-24T14:12:12",
      "id": 5,
      "unsubscribe_text": "sample string 6",
      "can_unsubscribe": true,
      "name": "sample string 7",
      "from_name": "sample string 8",
      "content": "sample string 9",
      "segment": {
        "group_ids": [
          1,
          2
        ],
        "restricated_group_ids": [
          1,
          2
        ],
        "restricated_campaign_ids": [
          1,
          2
        ],
        "mailing_list_id": 1,
        "limit_amount": 1,
        "sms_sending_profile_id": 1
      },
      "scheduling": {
        "is_sent": true,
        "scheduled_time_zone": "Israel",
        "scheduled_date": "2016-12-24T14:12:12"
      },
      "is_link_tracking": true
    },
    {
      "send_type": "Regular",
      "send_type_name": "sample string 1",
      "status_id": 2,
      "status_name": "sample string 3",
      "total_sent": 4,
      "status_date": "2016-12-24T14:12:12",
      "handled_date": "2016-12-24T14:12:12",
      "id": 5,
      "unsubscribe_text": "sample string 6",
      "can_unsubscribe": true,
      "name": "sample string 7",
      "from_name": "sample string 8",
      "content": "sample string 9",
      "segment": {
        "group_ids": [
          1,
          2
        ],
        "restricated_group_ids": [
          1,
          2
        ],
        "restricated_campaign_ids": [
          1,
          2
        ],
        "mailing_list_id": 1,
        "limit_amount": 1,
        "sms_sending_profile_id": 1
      },
      "scheduling": {
        "is_sent": true,
        "scheduled_time_zone": "Israel",
        "scheduled_date": "2016-12-24T14:12:12"
      },
      "is_link_tracking": true
    }
  ],
  "total_items": 1
}

application/xml, text/xml

Sample: 
<ApiSmsCampaignInfoCampaignList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport">
  <sms_campaign>
    <ApiSmsCampaignInfoCampaign>
      <content>sample string 9</content>
      <from_name>sample string 8</from_name>
      <is_link_tracking>true</is_link_tracking>
      <name>sample string 7</name>
      <scheduling>
        <is_sent>true</is_sent>
        <scheduled_date>2016-12-24T14:12:12</scheduled_date>
        <scheduled_time_zone>Israel</scheduled_time_zone>
      </scheduling>
      <segment>
        <group_ids xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </group_ids>
        <limit_amount>1</limit_amount>
        <mailing_list_id>1</mailing_list_id>
        <restricated_campaign_ids xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </restricated_campaign_ids>
        <restricated_group_ids xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </restricated_group_ids>
        <sms_sending_profile_id>1</sms_sending_profile_id>
      </segment>
      <can_unsubscribe>true</can_unsubscribe>
      <handled_date>2016-12-24T14:12:12</handled_date>
      <id>5</id>
      <send_type_name>sample string 1</send_type_name>
      <status_date>2016-12-24T14:12:12</status_date>
      <status_id>2</status_id>
      <status_name>sample string 3</status_name>
      <total_sent>4</total_sent>
      <unsubscribe_text>sample string 6</unsubscribe_text>
    </ApiSmsCampaignInfoCampaign>
    <ApiSmsCampaignInfoCampaign>
      <content>sample string 9</content>
      <from_name>sample string 8</from_name>
      <is_link_tracking>true</is_link_tracking>
      <name>sample string 7</name>
      <scheduling>
        <is_sent>true</is_sent>
        <scheduled_date>2016-12-24T14:12:12</scheduled_date>
        <scheduled_time_zone>Israel</scheduled_time_zone>
      </scheduling>
      <segment>
        <group_ids xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </group_ids>
        <limit_amount>1</limit_amount>
        <mailing_list_id>1</mailing_list_id>
        <restricated_campaign_ids xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </restricated_campaign_ids>
        <restricated_group_ids xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>1</d5p1:long>
          <d5p1:long>2</d5p1:long>
        </restricated_group_ids>
        <sms_sending_profile_id>1</sms_sending_profile_id>
      </segment>
      <can_unsubscribe>true</can_unsubscribe>
      <handled_date>2016-12-24T14:12:12</handled_date>
      <id>5</id>
      <send_type_name>sample string 1</send_type_name>
      <status_date>2016-12-24T14:12:12</status_date>
      <status_id>2</status_id>
      <status_name>sample string 3</status_name>
      <total_sent>4</total_sent>
      <unsubscribe_text>sample string 6</unsubscribe_text>
    </ApiSmsCampaignInfoCampaign>
  </sms_campaign>
  <total_items>1</total_items>
</ApiSmsCampaignInfoCampaignList>