GET api/Whatsapp/GetPendingWhatsappMessage?ClientToken={ClientToken}

Request Information

URI Parameters

Name	Description	Type	Additional information
ClientToken		string	Required

Body Parameters

None.

Response Information

Resource Description

WhatsappMessage

Name	Type	Additional information
response	string	None.
message	string	None.
data	Collection of Datum	None.

Response Formats

application/json, text/json

Sample:

{
  "response": "sample string 1",
  "message": "sample string 2",
  "data": [
    {
      "AccountId": "sample string 1",
      "ChannelName": "sample string 2",
      "AccountPath": "sample string 3",
      "ClientCode": "sample string 4",
      "message": [
        {
          "messageId": "sample string 1",
          "messageToNumber": "sample string 2",
          "messageText": "sample string 3",
          "messageImage": [
            {
              "messageImageId": "sample string 1",
              "messageImagePath": "sample string 2",
              "messageImageCaption": "sample string 3"
            },
            {
              "messageImageId": "sample string 1",
              "messageImagePath": "sample string 2",
              "messageImageCaption": "sample string 3"
            }
          ]
        },
        {
          "messageId": "sample string 1",
          "messageToNumber": "sample string 2",
          "messageText": "sample string 3",
          "messageImage": [
            {
              "messageImageId": "sample string 1",
              "messageImagePath": "sample string 2",
              "messageImageCaption": "sample string 3"
            },
            {
              "messageImageId": "sample string 1",
              "messageImagePath": "sample string 2",
              "messageImageCaption": "sample string 3"
            }
          ]
        }
      ]
    },
    {
      "AccountId": "sample string 1",
      "ChannelName": "sample string 2",
      "AccountPath": "sample string 3",
      "ClientCode": "sample string 4",
      "message": [
        {
          "messageId": "sample string 1",
          "messageToNumber": "sample string 2",
          "messageText": "sample string 3",
          "messageImage": [
            {
              "messageImageId": "sample string 1",
              "messageImagePath": "sample string 2",
              "messageImageCaption": "sample string 3"
            },
            {
              "messageImageId": "sample string 1",
              "messageImagePath": "sample string 2",
              "messageImageCaption": "sample string 3"
            }
          ]
        },
        {
          "messageId": "sample string 1",
          "messageToNumber": "sample string 2",
          "messageText": "sample string 3",
          "messageImage": [
            {
              "messageImageId": "sample string 1",
              "messageImagePath": "sample string 2",
              "messageImageCaption": "sample string 3"
            },
            {
              "messageImageId": "sample string 1",
              "messageImagePath": "sample string 2",
              "messageImageCaption": "sample string 3"
            }
          ]
        }
      ]
    }
  ]
}

text/html

Sample:

{"response":"sample string 1","message":"sample string 2","data":[{"AccountId":"sample string 1","ChannelName":"sample string 2","AccountPath":"sample string 3","ClientCode":"sample string 4","message":[{"messageId":"sample string 1","messageToNumber":"sample string 2","messageText":"sample string 3","messageImage":[{"messageImageId":"sample string 1","messageImagePath":"sample string 2","messageImageCaption":"sample string 3"},{"messageImageId":"sample string 1","messageImagePath":"sample string 2","messageImageCaption":"sample string 3"}]},{"messageId":"sample string 1","messageToNumber":"sample string 2","messageText":"sample string 3","messageImage":[{"messageImageId":"sample string 1","messageImagePath":"sample string 2","messageImageCaption":"sample string 3"},{"messageImageId":"sample string 1","messageImagePath":"sample string 2","messageImageCaption":"sample string 3"}]}]},{"AccountId":"sample string 1","ChannelName":"sample string 2","AccountPath":"sample string 3","ClientCode":"sample string 4","message":[{"messageId":"sample string 1","messageToNumber":"sample string 2","messageText":"sample string 3","messageImage":[{"messageImageId":"sample string 1","messageImagePath":"sample string 2","messageImageCaption":"sample string 3"},{"messageImageId":"sample string 1","messageImagePath":"sample string 2","messageImageCaption":"sample string 3"}]},{"messageId":"sample string 1","messageToNumber":"sample string 2","messageText":"sample string 3","messageImage":[{"messageImageId":"sample string 1","messageImagePath":"sample string 2","messageImageCaption":"sample string 3"},{"messageImageId":"sample string 1","messageImagePath":"sample string 2","messageImageCaption":"sample string 3"}]}]}]}

application/xml, text/xml

Sample:

<WhatsappModels.WhatsappMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Automation.Models">
  <data>
    <WhatsappModels.Datum>
      <AccountId>sample string 1</AccountId>
      <AccountPath>sample string 3</AccountPath>
      <ChannelName>sample string 2</ChannelName>
      <ClientCode>sample string 4</ClientCode>
      <message>
        <WhatsappModels.Message>
          <messageId>sample string 1</messageId>
          <messageImage>
            <WhatsappModels.MessageImage>
              <messageImageCaption>sample string 3</messageImageCaption>
              <messageImageId>sample string 1</messageImageId>
              <messageImagePath>sample string 2</messageImagePath>
            </WhatsappModels.MessageImage>
            <WhatsappModels.MessageImage>
              <messageImageCaption>sample string 3</messageImageCaption>
              <messageImageId>sample string 1</messageImageId>
              <messageImagePath>sample string 2</messageImagePath>
            </WhatsappModels.MessageImage>
          </messageImage>
          <messageText>sample string 3</messageText>
          <messageToNumber>sample string 2</messageToNumber>
        </WhatsappModels.Message>
        <WhatsappModels.Message>
          <messageId>sample string 1</messageId>
          <messageImage>
            <WhatsappModels.MessageImage>
              <messageImageCaption>sample string 3</messageImageCaption>
              <messageImageId>sample string 1</messageImageId>
              <messageImagePath>sample string 2</messageImagePath>
            </WhatsappModels.MessageImage>
            <WhatsappModels.MessageImage>
              <messageImageCaption>sample string 3</messageImageCaption>
              <messageImageId>sample string 1</messageImageId>
              <messageImagePath>sample string 2</messageImagePath>
            </WhatsappModels.MessageImage>
          </messageImage>
          <messageText>sample string 3</messageText>
          <messageToNumber>sample string 2</messageToNumber>
        </WhatsappModels.Message>
      </message>
    </WhatsappModels.Datum>
    <WhatsappModels.Datum>
      <AccountId>sample string 1</AccountId>
      <AccountPath>sample string 3</AccountPath>
      <ChannelName>sample string 2</ChannelName>
      <ClientCode>sample string 4</ClientCode>
      <message>
        <WhatsappModels.Message>
          <messageId>sample string 1</messageId>
          <messageImage>
            <WhatsappModels.MessageImage>
              <messageImageCaption>sample string 3</messageImageCaption>
              <messageImageId>sample string 1</messageImageId>
              <messageImagePath>sample string 2</messageImagePath>
            </WhatsappModels.MessageImage>
            <WhatsappModels.MessageImage>
              <messageImageCaption>sample string 3</messageImageCaption>
              <messageImageId>sample string 1</messageImageId>
              <messageImagePath>sample string 2</messageImagePath>
            </WhatsappModels.MessageImage>
          </messageImage>
          <messageText>sample string 3</messageText>
          <messageToNumber>sample string 2</messageToNumber>
        </WhatsappModels.Message>
        <WhatsappModels.Message>
          <messageId>sample string 1</messageId>
          <messageImage>
            <WhatsappModels.MessageImage>
              <messageImageCaption>sample string 3</messageImageCaption>
              <messageImageId>sample string 1</messageImageId>
              <messageImagePath>sample string 2</messageImagePath>
            </WhatsappModels.MessageImage>
            <WhatsappModels.MessageImage>
              <messageImageCaption>sample string 3</messageImageCaption>
              <messageImageId>sample string 1</messageImageId>
              <messageImagePath>sample string 2</messageImagePath>
            </WhatsappModels.MessageImage>
          </messageImage>
          <messageText>sample string 3</messageText>
          <messageToNumber>sample string 2</messageToNumber>
        </WhatsappModels.Message>
      </message>
    </WhatsappModels.Datum>
  </data>
  <message>sample string 2</message>
  <response>sample string 1</response>
</WhatsappModels.WhatsappMessage>