POST api/whatsapp/send

Request Information

URI Parameters

None.

Body Parameters

WhatsAppMessage
NameDescriptionTypeAdditional information
ClientIds

string

None.

Message

string

None.

Title

string

None.

Footer

string

None.

Buttons

string

None.

Urls

string

None.

ButtonList

ButtonData

None.

UrlList

UrlData

None.

SendList

ListData

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientIds": "sample string 1",
  "Message": "sample string 2",
  "Title": "sample string 3",
  "Footer": "sample string 4",
  "Buttons": "sample string 5",
  "Urls": "sample string 6",
  "ButtonList": {
    "useTemplateButtons": true,
    "title": "sample string 2",
    "footer": "sample string 3",
    "buttons": [
      {
        "id": "sample string 1",
        "text": "sample string 2"
      },
      {
        "id": "sample string 1",
        "text": "sample string 2"
      }
    ]
  },
  "UrlList": {
    "useTemplateButtons": true,
    "title": "sample string 2",
    "footer": "sample string 3",
    "buttonsUrl": [
      {
        "id": "sample string 1",
        "text": "sample string 2",
        "url": "sample string 3"
      },
      {
        "id": "sample string 1",
        "text": "sample string 2",
        "url": "sample string 3"
      }
    ]
  },
  "SendList": {
    "ButtonText": "sample string 1",
    "Description": "sample string 2",
    "Sections": [
      {
        "Title": "sample string 1",
        "Rows": [
          {
            "RowId": "sample string 1",
            "Title": "sample string 2",
            "Description": "sample string 3"
          },
          {
            "RowId": "sample string 1",
            "Title": "sample string 2",
            "Description": "sample string 3"
          }
        ]
      },
      {
        "Title": "sample string 1",
        "Rows": [
          {
            "RowId": "sample string 1",
            "Title": "sample string 2",
            "Description": "sample string 3"
          },
          {
            "RowId": "sample string 1",
            "Title": "sample string 2",
            "Description": "sample string 3"
          }
        ]
      }
    ]
  }
}

text/html

Sample:
{"ClientIds":"sample string 1","Message":"sample string 2","Title":"sample string 3","Footer":"sample string 4","Buttons":"sample string 5","Urls":"sample string 6","ButtonList":{"useTemplateButtons":true,"title":"sample string 2","footer":"sample string 3","buttons":[{"id":"sample string 1","text":"sample string 2"},{"id":"sample string 1","text":"sample string 2"}]},"UrlList":{"useTemplateButtons":true,"title":"sample string 2","footer":"sample string 3","buttonsUrl":[{"id":"sample string 1","text":"sample string 2","url":"sample string 3"},{"id":"sample string 1","text":"sample string 2","url":"sample string 3"}]},"SendList":{"ButtonText":"sample string 1","Description":"sample string 2","Sections":[{"Title":"sample string 1","Rows":[{"RowId":"sample string 1","Title":"sample string 2","Description":"sample string 3"},{"RowId":"sample string 1","Title":"sample string 2","Description":"sample string 3"}]},{"Title":"sample string 1","Rows":[{"RowId":"sample string 1","Title":"sample string 2","Description":"sample string 3"},{"RowId":"sample string 1","Title":"sample string 2","Description":"sample string 3"}]}]}}

application/xml, text/xml

Sample:
<WhatsAppMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FoneClube.Business.Commons.Entities.FoneClube">
  <ButtonList>
    <buttons>
      <ButtonRows>
        <id>sample string 1</id>
        <text>sample string 2</text>
      </ButtonRows>
      <ButtonRows>
        <id>sample string 1</id>
        <text>sample string 2</text>
      </ButtonRows>
    </buttons>
    <footer>sample string 3</footer>
    <title>sample string 2</title>
    <useTemplateButtons>true</useTemplateButtons>
  </ButtonList>
  <Buttons>sample string 5</Buttons>
  <ClientIds>sample string 1</ClientIds>
  <Footer>sample string 4</Footer>
  <Message>sample string 2</Message>
  <SendList>
    <ButtonText>sample string 1</ButtonText>
    <Description>sample string 2</Description>
    <Sections>
      <ListSection>
        <Rows>
          <ListRow>
            <Description>sample string 3</Description>
            <RowId>sample string 1</RowId>
            <Title>sample string 2</Title>
          </ListRow>
          <ListRow>
            <Description>sample string 3</Description>
            <RowId>sample string 1</RowId>
            <Title>sample string 2</Title>
          </ListRow>
        </Rows>
        <Title>sample string 1</Title>
      </ListSection>
      <ListSection>
        <Rows>
          <ListRow>
            <Description>sample string 3</Description>
            <RowId>sample string 1</RowId>
            <Title>sample string 2</Title>
          </ListRow>
          <ListRow>
            <Description>sample string 3</Description>
            <RowId>sample string 1</RowId>
            <Title>sample string 2</Title>
          </ListRow>
        </Rows>
        <Title>sample string 1</Title>
      </ListSection>
    </Sections>
  </SendList>
  <Title>sample string 3</Title>
  <UrlList>
    <buttonsUrl>
      <ButtonUrlRows>
        <id>sample string 1</id>
        <text>sample string 2</text>
        <url>sample string 3</url>
      </ButtonUrlRows>
      <ButtonUrlRows>
        <id>sample string 1</id>
        <text>sample string 2</text>
        <url>sample string 3</url>
      </ButtonUrlRows>
    </buttonsUrl>
    <footer>sample string 3</footer>
    <title>sample string 2</title>
    <useTemplateButtons>true</useTemplateButtons>
  </UrlList>
  <Urls>sample string 6</Urls>
</WhatsAppMessage>

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

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>