POST webhook/zapi

Request Information

URI Parameters

None.

Body Parameters

ZApiWebhookDto
NameDescriptionTypeAdditional information
instanceId

string

None.

phone

string

None.

senderName

string

None.

type

string

None.

fromMe

boolean

None.

isGroup

boolean

None.

chatName

string

None.

chatLid

string

None.

participantPhone

string

None.

text

ZApiWebhookText

None.

image

ZApiWebhookImage

None.

audio

ZApiWebhookAudio

None.

document

ZApiWebhookDocument

None.

Request Formats

application/json, text/json

Sample:
{
  "instanceId": "sample string 1",
  "phone": "sample string 2",
  "senderName": "sample string 3",
  "type": "sample string 4",
  "fromMe": true,
  "isGroup": true,
  "chatName": "sample string 7",
  "chatLid": "sample string 8",
  "participantPhone": "sample string 9",
  "text": {
    "message": "sample string 1"
  },
  "image": {
    "imageUrl": "sample string 1",
    "thumbnailUrl": "sample string 2",
    "caption": "sample string 3",
    "mimeType": "sample string 4",
    "viewOnce": true,
    "width": 6,
    "height": 7
  },
  "audio": {
    "ptt": true,
    "seconds": 2,
    "audioUrl": "sample string 3",
    "mimeType": "sample string 4",
    "viewOnce": true
  },
  "document": {
    "caption": "sample string 1",
    "documentUrl": "sample string 2",
    "fileName": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<ZApiWebhookDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgenteNotificador.Models.Webhook">
  <audio>
    <audioUrl>sample string 3</audioUrl>
    <mimeType>sample string 4</mimeType>
    <ptt>true</ptt>
    <seconds>2</seconds>
    <viewOnce>true</viewOnce>
  </audio>
  <chatLid>sample string 8</chatLid>
  <chatName>sample string 7</chatName>
  <document>
    <caption>sample string 1</caption>
    <documentUrl>sample string 2</documentUrl>
    <fileName>sample string 3</fileName>
  </document>
  <fromMe>true</fromMe>
  <image>
    <caption>sample string 3</caption>
    <height>7</height>
    <imageUrl>sample string 1</imageUrl>
    <mimeType>sample string 4</mimeType>
    <thumbnailUrl>sample string 2</thumbnailUrl>
    <viewOnce>true</viewOnce>
    <width>6</width>
  </image>
  <instanceId>sample string 1</instanceId>
  <isGroup>true</isGroup>
  <participantPhone>sample string 9</participantPhone>
  <phone>sample string 2</phone>
  <senderName>sample string 3</senderName>
  <text>
    <message>sample string 1</message>
  </text>
  <type>sample string 4</type>
</ZApiWebhookDto>

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.