POST api/Campaign/SendMessages

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Name	string	None.
CampaignType	string	None.
CampaignId	integer	None.
LeadSourceId	integer	None.
CampaignChannelId	integer	None.
SubSource	string	None.
Message	string	None.
Subject	string	None.
Sender	string	None.
ReplyToMail	string	None.
TemplateName	string	None.
Url	string	None.
Remark	string	None.
Documents	Collection of ImageVM	None.
Segments	Collection of integer	None.
Ivrs	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "CampaignType": "sample string 2",
  "CampaignId": 3,
  "LeadSourceId": 1,
  "CampaignChannelId": 1,
  "SubSource": "sample string 4",
  "Message": "sample string 5",
  "Subject": "sample string 6",
  "Sender": "sample string 7",
  "ReplyToMail": "sample string 8",
  "TemplateName": "sample string 9",
  "Url": "sample string 10",
  "Remark": "sample string 11",
  "Documents": [
    {
      "Id": 1,
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Description": "sample string 3",
      "Type": "sample string 4",
      "Category": "sample string 5",
      "Base64Url": "sample string 6"
    },
    {
      "Id": 1,
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Description": "sample string 3",
      "Type": "sample string 4",
      "Category": "sample string 5",
      "Base64Url": "sample string 6"
    }
  ],
  "Segments": [
    1,
    2
  ],
  "Ivrs": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<SendCampaignMessageVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Services.Campaign">
  <CampaignChannelId>1</CampaignChannelId>
  <CampaignId>3</CampaignId>
  <CampaignType>sample string 2</CampaignType>
  <Documents xmlns:d2p1="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
    <d2p1:ImageVM>
      <d2p1:Base64Url>sample string 6</d2p1:Base64Url>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Type>sample string 4</d2p1:Type>
      <d2p1:Url>sample string 2</d2p1:Url>
    </d2p1:ImageVM>
    <d2p1:ImageVM>
      <d2p1:Base64Url>sample string 6</d2p1:Base64Url>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Type>sample string 4</d2p1:Type>
      <d2p1:Url>sample string 2</d2p1:Url>
    </d2p1:ImageVM>
  </Documents>
  <Ivrs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </Ivrs>
  <LeadSourceId>1</LeadSourceId>
  <Message>sample string 5</Message>
  <Name>sample string 1</Name>
  <Remark>sample string 11</Remark>
  <ReplyToMail>sample string 8</ReplyToMail>
  <Segments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </Segments>
  <Sender>sample string 7</Sender>
  <SubSource>sample string 4</SubSource>
  <Subject>sample string 6</Subject>
  <TemplateName>sample string 9</TemplateName>
  <Url>sample string 10</Url>
</SendCampaignMessageVm>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SendCampaignMessageVm'.

Response Information

Resource Description

Response

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Description	string	None.
Data	Object	None.
Count	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Data": {},
  "Count": 5
}

application/xml, text/xml

Sample:

<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Models">
  <Count>5</Count>
  <Data />
  <Description>sample string 3</Description>
  <Message>sample string 2</Message>
  <Success>true</Success>
</Response>