Skip to main content

Get chat history

Retrieves the chat message history

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

ParameterCLI optionTypeRequiredDescription
AccessParameters--accessStructure Of KeyAndValue✔Access parameters. See FormAccessParameters
ChatID--chatString✔Chat identifier
Count--countNumber✖Number of messages to receive

Returns: Map Of KeyAndValue - serialized JSON response from Green API


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);
    # 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 "120363410406221140@g.us"
Result
[
 {
  "type": "outgoing",
  "idMessage": "BAE5849D7A78175C",
  "timestamp": 1761913319,
  "typeMessage": "contactMessage",
  "chatId": "120363410406221140@g.us",
  "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": "BAE557AE1AB1719C",
   "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": true,
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "BAE557AE1AB1719C",
  "timestamp": 1761913318,
  "typeMessage": "contactMessage",
  "chatId": "120363410406221140@g.us",
  "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": true,
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "BAE59A9575828393",
  "timestamp": 1761913317,
  "typeMessage": "locationMessage",
  "chatId": "120363410406221140@g.us",
  "location": {
   "nameLocation": "",
   "address": "",
   "jpegThumbnail": "",
   "latitude": 53.908522,
   "longitude": 27.574821,
   "forwardingScore": 0,
   "isForwarded": false
  },
  "quotedMessage": {
   "stanzaId": "BAE5622BEDED47FB",
   "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": true,
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "BAE5622BEDED47FB",
  "timestamp": 1761913316,
  "typeMessage": "locationMessage",
  "chatId": "120363410406221140@g.us",
  "location": {
   "nameLocation": "Victory Square, Minsk",
   "address": "Victory sq.",
   "jpegThumbnail": "",
   "latitude": 53.908522,
   "longitude": 27.574821,
   "forwardingScore": 0,
   "isForwarded": false
  },
  "statusMessage": "sent",
  "sendByApi": true,
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "BAE57AD927913391",
  "timestamp": 1761913315,
  "typeMessage": "pollMessage",
  "chatId": "120363410406221140@g.us",
  "pollMessageData": {
   "name": "What's your favorite color?",
   "options": [
    {
     "optionName": "Red"
    },
    {
     "optionName": "Yellow"
    },
    {
     "optionName": "Green"
    }
   ],
   "multipleAnswers": true
  },
  "quotedMessage": {
   "stanzaId": "BAE58A2EA4230621",
   "participant": "1234567890@c.us",
   "type": "",
   "typeMessage": "",
   "deletedMessageId": "",
   "editedMessageId": "",
   "isEdited": false,
   "isDeleted": false
  },
  "statusMessage": "sent",
  "sendByApi": true,
  "deletedMessageId": "",
...