POST api/WhatsApp/SendTemplateMessage

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SenderName	string	None.
Sender	string	None.
To	string	None.
Tos	Collection of string	None.
ReplyTo	string	None.
Cc	Collection of string	None.
Bcc	Collection of string	None.
Subject	string	None.
Message	string	None.
Type	string	None.
SubType	string	None.
Screen	string	None.
JsonData	string	None.
AndroidChannelId	string	None.
small_icon	string	None.
LeadName	string	None.
TemplateName	string	None.
BroadcastName	string	None.
TypeUID	string	None.
TypeId	string	None.
FollowupId	integer	None.
LeadId	integer	None.
CustomerId	integer	None.
UserId	integer	None.
DocumentUrl	string	None.
DocumentType	string	None.
UID	string	None.
ISCUrl	string	None.
Images	Collection of ImageVM	None.
WatiWpParameters	Collection of WatiWpTemplateParameterVm	None.

Request Formats

application/json, text/json

Sample:

{
  "SenderName": "sample string 1",
  "Sender": "sample string 2",
  "To": "sample string 3",
  "Tos": [
    "sample string 1",
    "sample string 2"
  ],
  "ReplyTo": "sample string 4",
  "Cc": [
    "sample string 1",
    "sample string 2"
  ],
  "Bcc": [
    "sample string 1",
    "sample string 2"
  ],
  "Subject": "sample string 5",
  "Message": "sample string 6",
  "Type": "sample string 7",
  "SubType": "sample string 8",
  "Screen": "sample string 9",
  "JsonData": "sample string 10",
  "AndroidChannelId": "sample string 11",
  "small_icon": "sample string 12",
  "LeadName": "sample string 13",
  "TemplateName": "sample string 14",
  "BroadcastName": "sample string 15",
  "TypeUID": "sample string 16",
  "TypeId": "sample string 17",
  "FollowupId": 1,
  "LeadId": 1,
  "CustomerId": 1,
  "UserId": 1,
  "DocumentUrl": "sample string 18",
  "DocumentType": "sample string 19",
  "UID": "sample string 20",
  "ISCUrl": "sample string 21",
  "Images": [
    {
      "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"
    }
  ],
  "WatiWpParameters": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<NotificationServiceVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BrokerServer.Api">
  <AndroidChannelId>sample string 11</AndroidChannelId>
  <Bcc xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Bcc>
  <BroadcastName>sample string 15</BroadcastName>
  <Cc xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Cc>
  <CustomerId>1</CustomerId>
  <DocumentType>sample string 19</DocumentType>
  <DocumentUrl>sample string 18</DocumentUrl>
  <FollowupId>1</FollowupId>
  <ISCUrl>sample string 21</ISCUrl>
  <Images 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>
  </Images>
  <JsonData>sample string 10</JsonData>
  <LeadId>1</LeadId>
  <LeadName>sample string 13</LeadName>
  <Message>sample string 6</Message>
  <ReplyTo>sample string 4</ReplyTo>
  <Screen>sample string 9</Screen>
  <Sender>sample string 2</Sender>
  <SenderName>sample string 1</SenderName>
  <SubType>sample string 8</SubType>
  <Subject>sample string 5</Subject>
  <TemplateName>sample string 14</TemplateName>
  <To>sample string 3</To>
  <Tos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tos>
  <Type>sample string 7</Type>
  <TypeId>sample string 17</TypeId>
  <TypeUID>sample string 16</TypeUID>
  <UID>sample string 20</UID>
  <UserId>1</UserId>
  <WatiWpParameters>
    <WatiWpTemplateParameterVm>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </WatiWpTemplateParameterVm>
    <WatiWpTemplateParameterVm>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </WatiWpTemplateParameterVm>
  </WatiWpParameters>
  <small_icon>sample string 12</small_icon>
</NotificationServiceVm>

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 'NotificationServiceVm'.

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>