For more information on using API

GET https://webapi.mymarketing.co.il/api/2waysms/getreplies?SearchTerm={SearchTerm}&CampaignId={CampaignId}&FromDate={FromDate}&ToDate={ToDate}&Limit={Limit}&Page={Page}

Get all the replies for virtual numbers

Request Information

URI Parameters

Name

Description

Type

Additional information

searchTerm

search by response

string
campaignId

SMS campaign id. Can be found using the endpoint "Get account's sms campaigns.." or in the UI (go to Mobile -> SMS -> SMS list -> inspect/F12)

integer
fromDate

The first date the replies you want were created. If not specified, it will be 3 months before 'toDate' (the default value is 3 last months when both fromDate and toDate are not specified)

date
toDate

The last date the replies you want were created. If not specified, it will be 3 months after 'fromDate' (the default value is 3 last months when both fromDate and toDate are not specified)

date
limit

Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records)

integer

Range: inclusive between 1 and 100

page

Get a specific page (number of pages is limited)

integer

Range: inclusive between 1 and 2147483647

Body Parameters

None.

Response Information

Resource Description

TwoWaySmsApiResponse

Name

Description

Type

Additional information

total

The total number of replies based on the request criteria regardless of page range

integer
replies

A list of replies returned based on the request criteria and page range

Collection of TwoWaySmsResponse

Response Formats

application/json, text/json

Sample: 
{
  "total": 1,
  "replies": [
    {
      "id": 1,
      "campaignId": 1,
      "crmUserId": 1,
      "mobile": "sample string 9",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "email": "sample string 5",
      "reply": "sample string 6",
      "date": "2016-12-24T14:12:12"
    },
    {
      "id": 1,
      "campaignId": 1,
      "crmUserId": 1,
      "mobile": "sample string 9",
      "firstName": "sample string 3",
      "lastName": "sample string 4",
      "email": "sample string 5",
      "reply": "sample string 6",
      "date": "2016-12-24T14:12:12"
    }
  ]
}

application/xml, text/xml

Sample: 
<TwoWaySmsApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.TwoWaySms">
  <Replies>
    <TwoWaySmsResponse>
      <CampaignId>1</CampaignId>
      <CrmUserId>1</CrmUserId>
      <Email>sample string 5</Email>
      <FirstName>sample string 3</FirstName>
      <Id>1</Id>
      <LastName>sample string 4</LastName>
      <Mobile>sample string 9</Mobile>
      <Reply>sample string 6</Reply>
      <ResponseDate>2016-12-24T14:12:12</ResponseDate>
    </TwoWaySmsResponse>
    <TwoWaySmsResponse>
      <CampaignId>1</CampaignId>
      <CrmUserId>1</CrmUserId>
      <Email>sample string 5</Email>
      <FirstName>sample string 3</FirstName>
      <Id>1</Id>
      <LastName>sample string 4</LastName>
      <Mobile>sample string 9</Mobile>
      <Reply>sample string 6</Reply>
      <ResponseDate>2016-12-24T14:12:12</ResponseDate>
    </TwoWaySmsResponse>
  </Replies>
  <Total>1</Total>
</TwoWaySmsApiResponse>