Получить список комментариев task.commentitem.getlist

Scope: task

Кто может выполнять метод: любой пользователь с правом доступа на чтение задачи или выше

Метод task.commentitem.getlist получает список комментариев задачи.

DEPRECATED

Развитие метода остановлено с версии модуля tasks 25.700.0. Метод task.commentitem.getlist не работает в новой карточке задач, используйте метод im.dialog.messages.get для работы с чатом задач.

Параметры метода

Передавайте параметры в запросе в соответствии с порядком в таблице. Если нарушить порядок, запрос вернет ошибку.

Обязательные параметры отмечены *

Название `тип`	Описание
TASKID* `integer`	Идентификатор задачи. Идентификатор задачи можно получить при создании новой задачи или методом получения списка задач
ORDER `object`	Объект для сортировки результата вида `{"поле": "значение сортировки", ... }`. Сортировать можно по полям: `ID` — идентификатор комментария `AUTHOR_ID` — идентификатор автора комментария `AUTHOR_NAME` — имя автора `AUTHOR_EMAIL` — почтовый адрес автора `POST_DATE` — дата публикации комментария Направление сортировки может принимать значения: `asc` — по возрастанию `desc` — по убыванию По умолчанию результат сортируется по убыванию идентификатора комментария
FILTER `object`	Объект для фильтрации результата вида `{"поле": "значение фильтра", ... }`. Значением фильтруемого поля может быть одиночное значение или массив значений. Фильтровать можно по полям: `ID` — идентификатор комментария `AUTHOR_ID` — идентификатор автора комментария `AUTHOR_NAME` — имя автора `POST_DATE` — дата публикации комментария Перед названием фильтруемого поля можно указать префикс с типом фильтрации: `!` — не равно `<=`— меньше либо равно `<` — меньше `>=`— больше либо равно `>` — больше По умолчанию записи не фильтруются

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":8017,"ORDER":{"POST_DATE":"asc"},"FILTER":{"AUTHOR_ID":503,">=POST_DATE":"2025-01-01"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.commentitem.getlist

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":8017,"ORDER":{"POST_DATE":"asc"},"FILTER":{"AUTHOR_ID":503,">=POST_DATE":"2025-01-01"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/task.commentitem.getlist

// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'task.commentitem.getlist',
            {
              "TASKID": 8017,
              "ORDER": {
                "POST_DATE": "asc",
              },
              "FILTER": {
                "AUTHOR_ID": 503,
                ">=POST_DATE": "2025-01-01",
              }
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
          const generator = $b24.fetchListMethod('task.commentitem.getlist', {
            "TASKID": 8017,
            "ORDER": {
              "POST_DATE": "asc",
            },
            "FILTER": {
              "AUTHOR_ID": 503,
              ">=POST_DATE": "2025-01-01",
            }
          }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
          const response = await $b24.callMethod('task.commentitem.getlist', {
            "TASKID": 8017,
            "ORDER": {
              "POST_DATE": "asc",
            },
            "FILTER": {
              "AUTHOR_ID": 503,
              ">=POST_DATE": "2025-01-01",
            }
          }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'task.commentitem.getlist',
                    [
                        'TASKID' => 8017,
                        'ORDER' => [
                            'POST_DATE' => 'asc',
                        ],
                        'FILTER' => [
                            'AUTHOR_ID' => 503,
                            '>=POST_DATE' => '2025-01-01',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting task comments: ' . $e->getMessage();
        }

BX24.callMethod(
            'task.commentitem.getlist',
            {
                "TASKID": 8017,
                "ORDER": {
                    "POST_DATE": "asc",
                },
                "FILTER": {
                    "AUTHOR_ID": 503,
                    ">=POST_DATE": "2025-01-01",
                }
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'task.commentitem.getlist',
            [
                'TASKID' => 8017,
                'ORDER' => [
                    'POST_DATE' => 'asc',
                ],
                'FILTER' => [
                    'AUTHOR_ID' => 503,
                    '>=POST_DATE' => '2025-01-01',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "POST_MESSAGE_HTML": null,
                    "ID": "3157",
                    "AUTHOR_ID": "503",
                    "AUTHOR_NAME": "Иван Иванов",
                    "AUTHOR_EMAIL": "",
                    "POST_DATE": "2025-07-15T14:31:00+03:00",
                    "POST_MESSAGE": "Фотографии во вложении",
                    "ATTACHED_OBJECTS": {
                        "973": {
                            "ATTACHMENT_ID": "973",
                            "NAME": "photo1.png",
                            "SIZE": "1495700",
                            "FILE_ID": "4755",
                            "DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=973&auth%5Bauth%5D=3edf7ca92&action=download&ncc=1",
                            "VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=973&auth%5Bauth%5D=3edf7ca92&action=show&ncc=1"
                        },
                        "975": {
                            "ATTACHMENT_ID": "975",
                            "NAME": "photo2.png",
                            "SIZE": "1017053",
                            "FILE_ID": "4753",
                            "DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=975&auth%5Bauth%5D=3edf7ca92&action=download&ncc=1",
                            "VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=975&auth%5Bauth%5D=3edf7ca92&action=show&ncc=1"
                        }
                    }
                },
                {
                    "POST_MESSAGE_HTML": null,
                    "ID": "3155",
                    "AUTHOR_ID": "503",
                    "AUTHOR_NAME": "Иван Иванов",
                    "AUTHOR_EMAIL": "",
                    "POST_DATE": "2025-07-15T14:30:00+03:00",
                    "POST_MESSAGE": "Подготовил новые фотографии",
                    "ATTACHED_OBJECTS": {}
                }
            ],
            "time": {
                "start": 1753270901.224447,
                "finish": 1753270901.343166,
                "duration": 0.11871910095214844,
                "processing": 0.06380701065063477,
                "date_start": "2025-07-23T14:41:41+03:00",
                "date_finish": "2025-07-23T14:41:41+03:00",
                "operating_reset_at": 1753271501,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `array`	Массив объектов. Каждый объект содержит описание комментария
POST_MESSAGE_HTML `string`	HTML-код комментария
ID `string`	Идентификатор комментария
AUTHOR_ID `string`	Идентификатор автора комментария
AUTHOR_NAME `string`	Имя автора комментария
AUTHOR_EMAIL `string`	Email автора комментария
POST_DATE `string`	Дата и время создания комментария
POST_MESSAGE `string`	Текст комментария
ATTACHED_OBJECTS `object`	Объект, содержащий информацию о вложениях. Ключ объекта — идентификатор вложения, а значение — объект с описанием файла
time `time`	Информация о времени выполнения запроса

Объект ATTACHED_OBJECTS

Название `тип`	Описание
ATTACHMENT_ID `string`	Идентификатор вложения
NAME `string`	Имя файла
SIZE `string`	Размер файла в байтах
FILE_ID `string`	Идентификатор файла на Диске
DOWNLOAD_URL `string`	URL для скачивания файла
VIEW_URL `string`	URL для просмотра файла

Обработка ошибок

HTTP-статус: 400

{
            "error":"ERROR_CORE",
            "error_description":"TASKS_ERROR_EXCEPTION_#256; Param #1 (arOrder) for method ctaskcommentitem::getlist() must not contain key ">=POST_DATE".; 256/TE/WRONG_ARGUMENTS.<br>"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#8; Action failed; 8/TE/ACTION_FAILED_TO_BE_PROCESSED	Указано неверное значение параметра или нет прав доступа к задаче
`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) for method ctaskcommentitem::getlist() expected to be of type "integer", but given something else.; 256/TE/WRONG_ARGUMENTS	Указан неверный тип значения для параметра, например, для `TASKID`
`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#256; Param #1 (arOrder) for method ctaskcommentitem::getlist() must not contain key ">=POST_DATE".; 256/TE/WRONG_ARGUMENTS	Параметры указаны в неверном порядке
`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#256; Param #2 (arFilter) for method ctaskcommentitem::getlist() must not contain key "%POST_DATE".; 256/TE/WRONG_ARGUMENTS	Неверно указано название параметра или префикс для фильтра

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Получить комментарий по id

Удалить комментарий

Получить список комментариев task.commentitem.getlist

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект ATTACHED_OBJECTSОбъект ATTACHED_OBJECTS

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение