For more information on using API

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

Get SMS message. You can get sms messages 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

ApiSmsCampaignInfoList

Name

Description

Type

Additional information

sms_campaign

List of SMS campaign

Collection of ApiSmsCampaignInfo
total_items

Total number of SMS campaign

integer

Response Formats

application/json, text/json

Sample:
{
  "sms_campaign": [
    {
      "id": 1,
      "name": "sample string 2",
      "from_name": "sample string 3",
      "sms_sending_profile_id": 4,
      "content": "sample string 5"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "from_name": "sample string 3",
      "sms_sending_profile_id": 4,
      "content": "sample string 5"
    }
  ],
  "total_items": 1
}

application/xml, text/xml

Sample:
<ApiSmsCampaignInfoList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport">
  <sms_campaign>
    <ApiSmsCampaignInfo>
      <content>sample string 5</content>
      <from_name>sample string 3</from_name>
      <name>sample string 2</name>
      <sms_sending_profile_id>4</sms_sending_profile_id>
    </ApiSmsCampaignInfo>
    <ApiSmsCampaignInfo>
      <content>sample string 5</content>
      <from_name>sample string 3</from_name>
      <name>sample string 2</name>
      <sms_sending_profile_id>4</sms_sending_profile_id>
    </ApiSmsCampaignInfo>
  </sms_campaign>
  <total_items>1</total_items>
</ApiSmsCampaignInfoList>