POST api/Campaign/ContactCountByCampaignRoutes

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AccountId	string	None.
CampaignId	string	None.
IsSmsRoute	boolean	None.
IsEmailRoute	boolean	None.
IsVoiceRoute	boolean	None.
EmailRouteOrder	integer	None.
SmsRouteOrder	integer	None.
VoiceRouteOrder	integer	None.
SendMultipleMessagesToContact	boolean	None.
TextTotalContacts	integer	None.
EmailTotalContacts	integer	None.
VoiceTotalContacts	integer	None.
TotalContactCount	integer	None.
CampaignCreatedFromModule	CampaignCreatedFromModule	None.
TextRouteContactsSummary	Collection of CampaignContactsByRoutesPriorityViewModel	None.
EmailRouteContactsSummary	Collection of CampaignContactsByRoutesPriorityViewModel	None.
VoiceRouteContactsSummary	Collection of CampaignContactsByRoutesPriorityViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountId": "sample string 1",
  "CampaignId": "sample string 2",
  "IsSmsRoute": true,
  "IsEmailRoute": true,
  "IsVoiceRoute": true,
  "EmailRouteOrder": 6,
  "SmsRouteOrder": 7,
  "VoiceRouteOrder": 8,
  "SendMultipleMessagesToContact": true,
  "TextTotalContacts": 10,
  "EmailTotalContacts": 11,
  "VoiceTotalContacts": 12,
  "TotalContactCount": 13,
  "CampaignCreatedFromModule": "Campaign",
  "TextRouteContactsSummary": [
    {
      "ContactId": "sample string 1",
      "MobileNumber": "sample string 2",
      "Email": "sample string 3",
      "CreatedDate": "2024-04-19T05:17:09.2659601+00:00",
      "CountryId": "sample string 5",
      "CountryCode": "sample string 6"
    },
    {
      "ContactId": "sample string 1",
      "MobileNumber": "sample string 2",
      "Email": "sample string 3",
      "CreatedDate": "2024-04-19T05:17:09.2659601+00:00",
      "CountryId": "sample string 5",
      "CountryCode": "sample string 6"
    }
  ],
  "EmailRouteContactsSummary": [
    {
      "ContactId": "sample string 1",
      "MobileNumber": "sample string 2",
      "Email": "sample string 3",
      "CreatedDate": "2024-04-19T05:17:09.2659601+00:00",
      "CountryId": "sample string 5",
      "CountryCode": "sample string 6"
    },
    {
      "ContactId": "sample string 1",
      "MobileNumber": "sample string 2",
      "Email": "sample string 3",
      "CreatedDate": "2024-04-19T05:17:09.2659601+00:00",
      "CountryId": "sample string 5",
      "CountryCode": "sample string 6"
    }
  ],
  "VoiceRouteContactsSummary": [
    {
      "ContactId": "sample string 1",
      "MobileNumber": "sample string 2",
      "Email": "sample string 3",
      "CreatedDate": "2024-04-19T05:17:09.2659601+00:00",
      "CountryId": "sample string 5",
      "CountryCode": "sample string 6"
    },
    {
      "ContactId": "sample string 1",
      "MobileNumber": "sample string 2",
      "Email": "sample string 3",
      "CreatedDate": "2024-04-19T05:17:09.2659601+00:00",
      "CountryId": "sample string 5",
      "CountryCode": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<CampaignRoutesContactSummaryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">
  <AccountId>sample string 1</AccountId>
  <CampaignCreatedFromModule>Campaign</CampaignCreatedFromModule>
  <CampaignId>sample string 2</CampaignId>
  <EmailRouteContactsSummary>
    <CampaignContactsByRoutesPriorityViewModel>
      <ContactId>sample string 1</ContactId>
      <CountryCode>sample string 6</CountryCode>
      <CountryId>sample string 5</CountryId>
      <CreatedDate>2024-04-19T05:17:09.2659601+00:00</CreatedDate>
      <Email>sample string 3</Email>
      <MobileNumber>sample string 2</MobileNumber>
    </CampaignContactsByRoutesPriorityViewModel>
    <CampaignContactsByRoutesPriorityViewModel>
      <ContactId>sample string 1</ContactId>
      <CountryCode>sample string 6</CountryCode>
      <CountryId>sample string 5</CountryId>
      <CreatedDate>2024-04-19T05:17:09.2659601+00:00</CreatedDate>
      <Email>sample string 3</Email>
      <MobileNumber>sample string 2</MobileNumber>
    </CampaignContactsByRoutesPriorityViewModel>
  </EmailRouteContactsSummary>
  <EmailRouteOrder>6</EmailRouteOrder>
  <EmailTotalContacts>11</EmailTotalContacts>
  <IsEmailRoute>true</IsEmailRoute>
  <IsSmsRoute>true</IsSmsRoute>
  <IsVoiceRoute>true</IsVoiceRoute>
  <SendMultipleMessagesToContact>true</SendMultipleMessagesToContact>
  <SmsRouteOrder>7</SmsRouteOrder>
  <TextRouteContactsSummary>
    <CampaignContactsByRoutesPriorityViewModel>
      <ContactId>sample string 1</ContactId>
      <CountryCode>sample string 6</CountryCode>
      <CountryId>sample string 5</CountryId>
      <CreatedDate>2024-04-19T05:17:09.2659601+00:00</CreatedDate>
      <Email>sample string 3</Email>
      <MobileNumber>sample string 2</MobileNumber>
    </CampaignContactsByRoutesPriorityViewModel>
    <CampaignContactsByRoutesPriorityViewModel>
      <ContactId>sample string 1</ContactId>
      <CountryCode>sample string 6</CountryCode>
      <CountryId>sample string 5</CountryId>
      <CreatedDate>2024-04-19T05:17:09.2659601+00:00</CreatedDate>
      <Email>sample string 3</Email>
      <MobileNumber>sample string 2</MobileNumber>
    </CampaignContactsByRoutesPriorityViewModel>
  </TextRouteContactsSummary>
  <TextTotalContacts>10</TextTotalContacts>
  <TotalContactCount>13</TotalContactCount>
  <VoiceRouteContactsSummary>
    <CampaignContactsByRoutesPriorityViewModel>
      <ContactId>sample string 1</ContactId>
      <CountryCode>sample string 6</CountryCode>
      <CountryId>sample string 5</CountryId>
      <CreatedDate>2024-04-19T05:17:09.2659601+00:00</CreatedDate>
      <Email>sample string 3</Email>
      <MobileNumber>sample string 2</MobileNumber>
    </CampaignContactsByRoutesPriorityViewModel>
    <CampaignContactsByRoutesPriorityViewModel>
      <ContactId>sample string 1</ContactId>
      <CountryCode>sample string 6</CountryCode>
      <CountryId>sample string 5</CountryId>
      <CreatedDate>2024-04-19T05:17:09.2659601+00:00</CreatedDate>
      <Email>sample string 3</Email>
      <MobileNumber>sample string 2</MobileNumber>
    </CampaignContactsByRoutesPriorityViewModel>
  </VoiceRouteContactsSummary>
  <VoiceRouteOrder>8</VoiceRouteOrder>
  <VoiceTotalContacts>12</VoiceTotalContacts>
</CampaignRoutesContactSummaryViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.