Get notification

Gets the latest notification from the queue

Parameters

Function GetNotification(Val AccessParameters, Val Timeout = 5, Val Delete = False) Export

Parameter	CLI option	Type	Required	Description
AccessParameters	--access	Structure Of KeyAndValue	✔	Access parameters. See FormAccessParameters
Timeout	--timeout	Number	✖	Timeout for waiting for a notification if the queue is empty
Delete	--del	Boolean	✖	Delete notification from the queue after retrieval

Returns

Map Of KeyAndValue - serialized JSON response from Green API

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

To get the next notification, the current notification must be deleted

Method at API documentation: ReceiveNotification

1C:Enterprise/OneScript code example

    ApiUrl           = "https://3100.api.green-api.com/v3";
    MediaUrl         = "https://3100.api.green-api.com/v3";
    IdInstance       = "31003...";
    ApiTokenInstance = "17915d8e0b4b4975a183478da...";

    AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenMax.GetNotification(AccessParameters);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint greenmax GetNotification \
      --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint greenmax GetNotification ^
      --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}"

Result

{
 "receiptId": 1,
 "body": {
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
   "idInstance": "***",
   "wid": "***",
   "typeInstance": "v3"
  },
  "timestamp": 1779801188,
  "idMessage": "1779801186604",
  "senderData": {
   "chatId": "***",
   "chatName": "***",
   "sender": "***",
   "senderName": "***",
   "senderContactName": "***",
   "senderPhoneNumber": "***"
  },
  "messageData": {
   "typeMessage": "extendedTextMessage",
   "extendedTextMessageData": {
    "text": "Текст сообщения",
    "description": "",
    "title": "",
    "previewType": "None",
    "jpegThumbnail": "",
    "forwardingScore": 0,
    "isForwarded": false
   }
  }
 }
}