Get chat history

Retrieves the chat message history

Parameters

Function GetChatHistory(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 identifier
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://7105.api.greenapi.com";
    MediaUrl         = "https://7105.media.greenapi.com";
    IdInstance       = "71051...";
    ApiTokenInstance = "425010d90e114aa6b78f0969e...";

    ChatID = "120363410406221140@g.us";

    AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenAPI.GetChatHistory(AccessParameters, ChatID);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint greenapi GetChatHistory \
      --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" \
      --chat "***"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint greenapi GetChatHistory ^
      --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ^
      --chat "***"

Result

[
 {
  "type": "outgoing",
  "idMessage": "3EB0412DB103E7A98FA456",
  "timestamp": 1784480843,
  "typeMessage": "deletedMessage",
  "chatId": "***",
  "deletedMessageData": {
   "stanzaId": "3EB0FC70ACA4A5A29AB6E6"
  },
  "statusMessage": "sent",
  "sendByApi": "***"
 },
 {
  "type": "outgoing",
  "idMessage": "3EB0ED6326288BE13B7E29",
  "timestamp": 1784480835,
  "typeMessage": "extendedTextMessage",
  "chatId": "***",
  "textMessage": "New message",
  "extendedTextMessage": {
   "text": "New message",
   "description": "",
   "title": "",
   "previewType": "None",
   "jpegThumbnail": "",
   "forwardingScore": 1,
   "isForwarded": true
  },
  "statusMessage": "sent",
  "sendByApi": "***",
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "3EB0314B1707F30CAA1FF9",
  "timestamp": 1784480833,
  "typeMessage": "contactMessage",
  "chatId": "***",
  "contact": {
   "displayName": "Bicycle",
   "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:;;;\nFN:Bicycle\nORG:Bicycle\nTEL;type=CELL;type=VOICE;waid=79001234568:+79001234568\nEND:VCARD",
   "forwardingScore": 0,
   "isForwarded": false
  },
  "quotedMessage": {
   "stanzaId": "3EB07DEC3816862B015DD0",
   "participant": "1234567890@c.us",
   "typeMessage": "contactMessage",
   "contact": {
    "displayName": "Artem Evpatoriysky Petrovich",
    "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Petrovich;Artem;Evpatoriysky;\nFN:Artem Evpatoriysky Petrovich\nORG:Bicycle\nTEL;type=CELL;type=VOICE;waid=79001234568:+79001234568\nEND:VCARD",
    "forwardingScore": 0,
    "isForwarded": false
   },
   "deletedMessageId": "",
   "editedMessageId": "",
   "isEdited": false,
   "isDeleted": false
  },
  "statusMessage": "sent",
  "sendByApi": "***",
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "3EB07DEC3816862B015DD0",
  "timestamp": 1784480831,
  "typeMessage": "contactMessage",
  "chatId": "***",
  "contact": {
   "displayName": "Artem Evpatoriysky Petrovich",
   "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Petrovich;Artem;Evpatoriysky;\nFN:Artem Evpatoriysky Petrovich\nORG:Bicycle\nTEL;type=CELL;type=VOICE;waid=79001234568:+79001234568\nEND:VCARD",
   "forwardingScore": 0,
   "isForwarded": false
  },
  "statusMessage": "sent",
  "sendByApi": "***",
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "3EB0E3324BFB94CCF02E61",
  "timestamp": 1784480829,
  "typeMessage": "locationMessage",
  "chatId": "***",
  "location": {
   "nameLocation": "",
   "address": "",
   "jpegThumbnail": "",
   "latitude": 53.908522,
   "longitude": 27.574821,
   "forwardingScore": 0,
   "isForwarded": false
  },
  "quotedMessage": {
   "stanzaId": "3EB019B4149E270CF5EC12",
   "participant": "1234567890@c.us",
   "typeMessage": "locationMessage",
   "location": {
    "nameLocation": "Victory Square, Minsk",
    "address": "Victory sq.",
    "jpegThumbnail": "",
    "latitude": 53.908522,
    "longitude": 27.574821,
    "forwardingScore": 0,
    "isForwarded": false
   },
   "deletedMessageId": "",
   "editedMessageId": "",
   "isEdited": false,
   "isDeleted": false
  },
  "statusMessage": "sent",
  "sendByApi": "***",
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "3EB019B4149E270CF5EC12",
  "timestamp": 1784480827,
  "typeMessage": "locationMessage",
  "chatId": "***",
  "location": {
   "nameLocation": "Victory Square, Minsk",
   "address": "Victory sq.",
   "jpegThumbnail": "",
   "latitude": 53.908522,
   "longitude": 27.574821,
   "forwardingScore": 0,
   "isForwarded": false
  },
  "statusMessage": "sent",
  "sendByApi": "***",
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
...