Получить список комментариев crm.timeline.comment.list

Scope: crm

Кто может выполнять метод: пользователь с доступом на чтение элементов CRM

Метод crm.timeline.comment.list получает список всех дел типа «Комментарий» указанного элемента CRM.

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

Название
тип

Описание

select
array

Массив полей, которые необходимо выбрать. Передавайте поля объекта result. Если не передан или передан пустой массив, будут возвращены все поля

filter*
object

Объект для фильтрации выбранных комментариев в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Фильтр работает по двум обязательным полям:

  • ENTITY_ID — ID элемента CRM, к которому привязан комментарий
  • ENTITY_TYPEтип объекта CRM, например: deal, lead, contact, company

order
object

Объект для сортировки выбранных комментариев в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Поддерживаются только поля ID, CREATED, AUTHOR_ID.

Возможные значения для order:

  • ASC — в порядке возрастания
  • DESC — в порядке убывания

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный: 50 записей.

Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"ENTITY_ID":10,"ENTITY_TYPE":"deal"},"select":["ID","CREATED","ENTITY_ID","ENTITY_TYPE","AUTHOR_ID","COMMENT","FILES"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.comment.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"ENTITY_ID":10,"ENTITY_TYPE":"deal"},"select":["ID","CREATED","ENTITY_ID","ENTITY_TYPE","AUTHOR_ID","COMMENT","FILES"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.timeline.comment.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'crm.timeline.comment.list',
            {
              filter: {
                "ENTITY_ID": 10,
                "ENTITY_TYPE": "deal",
              },
              select: [
                "ID",
                "CREATED",
                "ENTITY_ID",
                "ENTITY_TYPE",
                "AUTHOR_ID",
                "COMMENT", 
                "FILES",
              ],
            },
            (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('crm.timeline.comment.list', {
            filter: {
              "ENTITY_ID": 10,
              "ENTITY_TYPE": "deal",
            },
            select: [
              "ID",
              "CREATED",
              "ENTITY_ID",
              "ENTITY_TYPE",
              "AUTHOR_ID",
              "COMMENT", 
              "FILES",
            ],
          }, '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('crm.timeline.comment.list', {
            filter: {
              "ENTITY_ID": 10,
              "ENTITY_TYPE": "deal",
            },
            select: [
              "ID",
              "CREATED",
              "ENTITY_ID",
              "ENTITY_TYPE",
              "AUTHOR_ID",
              "COMMENT", 
              "FILES",
            ],
          }, 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(
                    'crm.timeline.comment.list',
                    [
                        'filter' => [
                            'ENTITY_ID'   => 10,
                            'ENTITY_TYPE' => 'deal',
                        ],
                        'select' => [
                            'ID',
                            'CREATED',
                            'ENTITY_ID',
                            'ENTITY_TYPE',
                            'AUTHOR_ID',
                            'COMMENT',
                            'FILES',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching timeline comments: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.timeline.comment.list",
            {
                filter: {
                    "ENTITY_ID": 10,
                    "ENTITY_TYPE": "deal",
                },
                select: [
                    "ID",
                    "CREATED",
                    "ENTITY_ID",
                    "ENTITY_TYPE",
                    "AUTHOR_ID",
                    "COMMENT", 
                    "FILES",
                ],
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.timeline.comment.list',
            [
                'filter' => [
                    'ENTITY_ID' => 10,
                    'ENTITY_TYPE' => 'deal',
                ],
                'select' => [
                    'ID',
                    'CREATED',
                    'ENTITY_ID',
                    'ENTITY_TYPE',
                    'AUTHOR_ID',
                    'COMMENT',
                    'FILES',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "999",
                    "ENTITY_ID": "2",
                    "ENTITY_TYPE": "deal",
                    "CREATED": "2020-03-02T12:00:00+03:00",
                    "COMMENT": "New comment was added",
                    "AUTHOR_ID": "1",
                    "FILES": {
                        "1": {
                            "id": 1,
                            "date": "2020-03-02T12:00:00+03:00",
                            "type": "image",
                            "name": "1.gif",
                            "size": 43,
                            "image": {
                                "width": 1,
                                "height": 1
                            },
                            "authorId": 1,
                            "authorName": "John Dou",
                            "urlPreview": "https://my.bitrix24.com/disk/showFile/930/?&ncc=1&width=640&height=640&signature=292f450929833cd881070155e05a2c41b5bb265ea8c8c1bc2108dbcbb56f667f&ts=1718366521&filename=1.gif",
                            "urlShow": "https://my.bitrix24.com/disk/showFile/930/?&ncc=1&ts=1718366521&filename=1.gif",
                            "urlDownload": "https://my.bitrix24.com/disk/downloadFile/930/?&ncc=1&filename=1.gif"
                        },
                        "2": {
                            "id": 2,
                            "date": "2020-03-02T12:00:00+03:00",
                            "type": "image",
                            "name": "2.gif",
                            "size": 43,
                            "image": {
                                "width": 1,
                                "height": 1
                            },
                            "authorId": 1,
                            "authorName": "John Dou",
                            "urlPreview": "https://my.bitrix24.com/disk/showFile/931/?&ncc=1&width=640&height=640&signature=118de010a40eff06fb9d691ee9235e2ef809a17780e46927bf8b12f8dc3224db&ts=1718366521&filename=2.gif",
                            "urlShow": "https://my.bitrix24.com/disk/showFile/931/?&ncc=1&ts=1718366521&filename=2.gif",
                            "urlDownload": "https://my.bitrix24.com/disk/downloadFile/931/?&ncc=1&filename=2.gif"
                        }
                    },
                },
                {
                    "ID": "1000",
                    "ENTITY_ID": "2",
                    "ENTITY_TYPE": "deal",
                    "CREATED": "2020-03-02T12:00:00+03:00",
                    "COMMENT": "Test comment",
                    "AUTHOR_ID": "1",
                    "FILES": {},
                }
            ],
            "total": 2,
            "time": {
                "start": 1715091541.642592,
                "finish": 1715091541.730599,
                "duration": 0.08800697326660156,
                "date_start": "2024-05-03T17:19:01+03:00",
                "date_finish": "2024-05-03T17:19:01+03:00",
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
array

Корневой элемент ответа, содержащий массив объектов с информацией о выбранных комментариях

total
integer

Общее количество найденных записей

time
time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Access denied."
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Cообщение об ошибке

Описание

Пустая строка

Access denied

Отсутствуют права на указанный элемент CRM

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

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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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