Get chat messages list

Gets a list of 20 chat or dialog messages, depending on the FirstID and LastID specified

Function GetChatMessagesList(Val URL, Val ChatID, Val LastID = "", Val FirstID = "", Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
ChatID	--chat	String, Number	✔	Chat ID (as chatXXX) or User ID (as XXX)
LastID	--last	String, Number	✖	Id of last message
FirstID	--first	String, Number	✖	ID of first message
Token	--token	String	✖	Access token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

tip

Method at API documentation: im.dialog.messages.get

1C:Enterprise/OneScript code example

    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
    ChatID = "chat4";

    Result = OPI_Bitrix24.GetChatMessagesList(URL, ChatID);

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "2f4e4067006e9f06006b12e400000001000...";
    UserID = 10;

    Result = OPI_Bitrix24.GetChatMessagesList(URL, UserID, , 0, Token);

Bash

    oint bitrix24 GetChatMessagesList \
     --url "b24-ar17wx.bitrix24.by" \
     --chat 10 \
     --first 0 \
     --token "***"

CMD/Bat

    oint bitrix24 GetChatMessagesList ^
     --url "b24-ar17wx.bitrix24.by" ^
     --chat 10 ^
     --first 0 ^
     --token "***"

Result

{
 "result": {
  "chat_id": 10,
  "messages": [
   {
    "id": 16,
    "chat_id": 10,
    "author_id": 0,
    "date": "2024-06-15T19:48:49+03:00",
    "text": "Я с вами в команде!",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": {
     "CODE": [
      "USER_JOIN"
     ]
    },
    "disappearing_date": null
   },
   {
    "id": 3808,
    "chat_id": 10,
    "author_id": 1,
    "date": "2024-07-13T17:45:29+03:00",
    "text": "Сообщение для теста",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": [],
    "disappearing_date": null
   },
   {
    "id": 3810,
    "chat_id": 10,
    "author_id": 10,
    "date": "2024-07-13T17:46:31+03:00",
    "text": "Понял",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": [],
    "disappearing_date": null
   },
   {
    "id": 3852,
    "chat_id": 10,
    "author_id": 10,
    "date": "2024-07-13T17:54:42+03:00",
    "text": "Принял",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": [],
    "disappearing_date": null
   },
   {
    "id": 3854,
    "chat_id": 10,
    "author_id": 10,
    "date": "2024-07-13T17:54:43+03:00",
    "text": "Записал",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": [],
    "disappearing_date": null
   },
   {
    "id": 4286,
    "chat_id": 10,
    "author_id": 1,
    "date": "2024-07-13T19:06:51+03:00",
    "text": "Текст сообщения",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": [],
    "disappearing_date": null
   },
   {
    "id": 4366,
    "chat_id": 10,
    "author_id": 1,
    "date": "2024-07-13T19:40:58+03:00",
    "text": "Message text",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": [],
    "disappearing_date": null
   },
   {
    "id": 4406,
    "chat_id": 10,
    "author_id": 1,
    "date": "2024-07-13T22:57:33+03:00",
    "text": "Это сообщение было удалено",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": {
     "IS_DELETED": "Y"
    },
    "disappearing_date": null
   },
   {
    "id": 4446,
    "chat_id": 10,
    "author_id": 1,
    "date": "2024-07-13T23:21:27+03:00",
    "text": "Текст сообщения",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": [],
    "disappearing_date": null
   },
   {
    "id": 4486,
    "chat_id": 10,
    "author_id": 1,
    "date": "2024-07-13T23:22:30+03:00",
    "text": "Это сообщение было удалено",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": {
     "IS_DELETED": "Y"
    },
    "disappearing_date": null
   },
   {
    "id": 4526,
    "chat_id": 10,
    "author_id": 1,
    "date": "2024-07-13T23:41:21+03:00",
    "text": "Это сообщение было удалено",
    "unread": false,
    "uuid": null,
    "replaces": [],
    "params": {
     "IS_DELETED": "Y"
    },
    "disappearing_date": null
   },
   {
    "id": 4668,
    "chat_id": 10,
    "author_id": 1,
...