Получить список сообщений чата
Получает список из 20 сообщений чата или диалога, в зависимости от указания IDПервого и IDПоследнего
- Параметры
- Расширенный вызов ?
Функция ПолучитьСписокСообщенийЧата(Знач URL, Знач IDЧата, Знач IDПоследнего = "", Знач IDПервого = "", Знач Токен = "") Экспорт
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|---|---|---|---|---|
| URL | --url | Строка | ✔ | URL внешнего вебхука или адрес Bitrix24 при использовании токена |
| IDЧата | --chat | Строка, Число | ✔ | ID чата (chatXXX) или пользователя (XXX) для диалога |
| IDПоследнего | --last | Строка, Число | ✖ | ID последнего загруженного сообщения |
| IDПервого | --first | Строка, Число | ✖ | ID первого загруженного сообщения |
| Токен | --token | Строка | ✖ | Токен авторизации, если используется не вебхук |
Возвращаемое значение
Соответствие Из КлючИЗначение - сериализованный JSON ответа от Bitrix24
| Параметр | Описание |
|---|---|
| proxy | ИнтернетПрокси или структура полей Протокол, Сервер, Порт, Пользователь, Пароль, ИспользоватьАутентификациюОС |
| timeout | Таймаут выполнения запроса |
| adv_response | Оформляет ответ в виде полной структуры HTTP-ответа с полями code, body и headers |
| retries | Число попыток отправки HTTP-запроса при коде 5** или внутренних ошибках клиента |
| dontwait | Создает фоновое задание и возвращает его данные (только для 1С и OneScript) |
подсказка
Метод в документации API: im.dialog.messages.get
Пример использования для 1С:Предприятие/OneScript
URL = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";
IDЧата = "chat4";
Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDЧата);
URL = "b24-ar17wx.bitrix24.by";
Токен = "a5b00469006e9f06006b12e400000001000...";
IDПользователя = 10;
Результат = OPI_Bitrix24.ПолучитьСписокСообщенийЧата(URL, IDПользователя, , 0, Токен);
- Bash
- CMD/Bat
oint bitrix24 ПолучитьСписокСообщенийЧата \
--url "b24-ar17wx.bitrix24.by" \
--chat "***" \
--first 0 \
--token "***"
oint bitrix24 ПолучитьСписокСообщенийЧата ^
--url "b24-ar17wx.bitrix24.by" ^
--chat "***" ^
--first 0 ^
--token "***"
Результат
{
"result": {
"chat_id": "***",
"messages": [
{
"id": 3808,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-13T14:45:29+00:00",
"text": "Сообщение для теста",
"unread": false,
"uuid": null,
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4286,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-13T16:06:51+00:00",
"text": "Текст сообщения",
"unread": false,
"uuid": null,
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4366,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-13T16:40:58+00:00",
"text": "Message text",
"unread": false,
"uuid": null,
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4406,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-13T19:57:33+00:00",
"text": "Это сообщение было удалено",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4446,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-13T20:21:27+00:00",
"text": "Текст сообщения",
"unread": false,
"uuid": null,
"replaces": [],
"params": [],
"disappearing_date": null
},
{
"id": 4486,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-13T20:22:30+00:00",
"text": "Это сообщение было удалено",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4526,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-13T20:41:21+00:00",
"text": "Это сообщение было удалено",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4668,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-14T08:10:33+00:00",
"text": "Это сообщение было удалено",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4708,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-14T08:22:56+00:00",
"text": "Это сообщение было удалено",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4748,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-14T08:26:01+00:00",
"text": "Это сообщение было удалено",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
{
"id": 4788,
"chat_id": "***",
"author_id": 1,
"date": "2024-07-14T08:28:01+00:00",
"text": "Это сообщение было удалено",
"unread": false,
"uuid": null,
"replaces": [],
"params": {
"IS_DELETED": "Y"
},
"disappearing_date": null
},
...