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 "***"
Result
[
 {
  "type": "outgoing",
  "idMessage": "3EB061688597DC5CBCC526",
  "timestamp": 1774431292,
  "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
 },
 {
  "type": "outgoing",
  "idMessage": "3EB00ED1CF6EBCA8C536B4",
  "timestamp": 1774431292,
  "typeMessage": "locationMessage",
  "chatId": "***",
  "location": {
   "nameLocation": "",
   "address": "",
   "jpegThumbnail": "",
   "latitude": 53.908522,
   "longitude": 27.574821,
   "forwardingScore": 0,
   "isForwarded": false
  },
  "quotedMessage": {
   "stanzaId": "3EB061688597DC5CBCC526",
   "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": "3EB0C272A314969B4BBAFB",
  "timestamp": 1774431291,
  "typeMessage": "pollMessage",
  "chatId": "***",
  "pollMessageData": {
   "name": "What's your favorite color??",
   "options": [
    {
     "optionName": "Red"
    },
    {
     "optionName": "Yellow"
    },
    {
     "optionName": "Green"
    }
   ],
   "multipleAnswers": true
  },
  "statusMessage": "sent",
  "sendByApi": "***",
  "deletedMessageId": "",
  "editedMessageId": "",
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "3EB08AAA2CD822F3CAAED8",
  "timestamp": 1774431290,
  "typeMessage": "videoMessage",
  "chatId": "***",
  "downloadUrl": "",
  "caption": "File description",
  "fileName": "",
  "jpegThumbnail": "/9j/2wCEAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB...",
  "mimeType": "video/mp4",
  "isAnimated": false,
  "isForwarded": false,
  "forwardingScore": 0,
  "quotedMessage": {
   "stanzaId": "3EB07548A36E66FF5D76C9",
   "participant": "1234567890@c.us",
   "typeMessage": "imageMessage",
   "downloadUrl": "",
   "caption": "File description",
   "fileName": "",
   "jpegThumbnail": "",
   "mimeType": "image/jpeg",
   "isAnimated": false,
   "isForwarded": false,
   "forwardingScore": 0,
   "editedMessageId": "",
   "deletedMessageId": "",
   "videoNote": false,
   "isEdited": false,
   "isDeleted": false
  },
  "statusMessage": "sent",
  "sendByApi": "***",
  "editedMessageId": "",
  "deletedMessageId": "",
  "videoNote": false,
  "isEdited": false,
  "isDeleted": false
 },
 {
  "type": "outgoing",
  "idMessage": "3EB0F23AE470D047B9BB2E",
  "timestamp": 1774431290,
  "typeMessage": "pollMessage",
  "chatId": "***",
  "pollMessageData": {
   "name": "What's your favorite color??",
   "options": [
    {
     "optionName": "Red"
    },
    {
     "optionName": "Yellow"
    },
    {
     "optionName": "Green"
    }
   ],
...