Get chat message history

Gets the latest messages from the chat history

Parameters

Function GetChatMessageHistory(Val AccessParameters, Val ChatID, Val Count = 100) Export

Parameter	CLI option	Type	Required	Description
AccessParameters	--access	Structure Of KeyAndValue	✔	Access parameters. See FormAccessParameters
ChatID	--chat	String	✔	Chat ID
Count	--count	Number	✖	Number of messages to receive

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

Method at API documentation: GetChatHistory

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...";

    ChatID = 12345678;
    Count  = 3;

    AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenMax.GetChatMessageHistory(AccessParameters, ChatID, Count);

Bash

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

CMD/Bat

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

Result

[
 {
  "type": "outgoing",
  "idMessage": "115440372143232131",
  "timestamp": 1761480287,
  "typeMessage": "textMessage",
  "chatId": "***",
  "textMessage": "Тест 5",
  "statusMessage": "delivered",
  "sendByApi": "***",
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "115440372011000418",
  "timestamp": 1761480285,
  "typeMessage": "textMessage",
  "chatId": "***",
  "textMessage": "Тест 4",
  "statusMessage": "delivered",
  "sendByApi": "***",
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "115440371862485754",
  "timestamp": 1761480283,
  "typeMessage": "textMessage",
  "chatId": "***",
  "textMessage": "Тест 3",
  "statusMessage": "delivered",
  "sendByApi": "***",
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 }
]