Green API

Receive notification

GET/waInstance{{idInstance}}/receiveNotification/{{apiTokenInstance}}

Documentation ReceiveNotification

Request

Query Params

receiveTimeout

string

required

Notification waiting timeout, takes a value from 5 to 60 seconds

Example:

Request samples

Responses

receiveNotification(200)

receiveNotification

HTTP Code: 200

Content Type : JSONapplication/json

receiptId

integer

required

body

object

required

typeWebhook

string

required

instanceData

object

required

timestamp

integer

required

idMessage

string

required

senderData

object

required

messageData

object

required

{
  "receiptId": 1234567,
  "body": {
    "typeWebhook": "incomingMessageReceived",
    "instanceData": {
      "idInstance": 1234,
      "wid": "11001234567@c.us",
      "typeInstance": "whatsapp"
    },
    "timestamp": 1588091580,
    "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
    "senderData": {
      "chatId": "79001234568@c.us",
      "sender": "79001234568@c.us",
      "senderName": "Green API"
    },
    "messageData": {
      "typeMessage": "textMessage",
      "textMessageData": {
        "textMessage": "I use Green-API to send this message to you!"
      }
    }
  }
}

Last modified: 18 days ago