Блог Горошко Андрея Bitrix24,PHP Получить список комментариев crm.timeline.comment.list

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

goroshckogoroshcko| Нет комментария|
Рубрики:

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить список комментариев crm.timeline.comment.list», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

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

> Scope: crm
>
> Кто может выполнять метод: любой пользователь

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

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

Название
тип		Описание
select
array		Массив содержит список полей, которые необходимо выбрать (смотрите поля объекта result). Если не передан или передан пустой массив, то результат вернет пустой массив
filter
object		Объект для фильтрации выбранных комментариев в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта result.

Обязательные поля: ENTITY_ID, ENTITY_TYPE.

Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

— >= — больше либо равно
— > — больше
— <= — меньше либо равно
— < — меньше
— @ — IN (в качестве значения передаётся массив)
— !@— NOT IN (в качестве значения передаётся массив)
— % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
— =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
— "мол%" — ищем значения, начинающиеся с «мол»
— "%мол" — ищем значения, заканчивающиеся на «мол»
— "%мол%" — ищем значения, где «мол» может быть в любой позиции
— %= — LIKE (см. описание выше)
— !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
— !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
— "мол%" — ищем значения, не начинающиеся с «мол»
— "%мол" — ищем значения, не заканчивающиеся на «мол»
— "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
— !%= — NOT LIKE (см. описание выше)
— = — равно, точное совпадение (используется по умолчанию)
— != — не равно
— ! — не равно

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

Возможные значения для field соответствуют полям объекта result.

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

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

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

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

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

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

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

Примеры кода

  • cURL (Webhook)
    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_webbhook_here**/crm.timeline.comment.list
  • cURL (OAuth)
    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
  • JS
    // 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);
    }
  • PHP
    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.js
    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());
        }
    );
  • PHP CRest
    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."
}

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

КодCообщение об ошибкеОписание
Пустая строкаAccess denied.Отсутствуют права на редактирование сущности в CRM
  • [](./crm-timeline-comment-add)
  • [](./crm-timeline-comment-update)
  • [](./crm-timeline-comment-get)
  • [](./crm-timeline-comment-delete)
  • [](./crm-timeline-comment-fields)

💡 Экспертное мнение и рекомендации

Советы эксперта по интеграции:

  • Всегда используйте кэширование при частых запросах к crm.timeline.comment.list, чтобы разгрузить базу данных.
  • Соблюдайте стандарты PSR при написании обработчиков для «Получить список комментариев crm.timeline.comment.list».
  • Регулярно проводите аудит производительности системы с помощью встроенного монитора 1С-Битрикс.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Изменить данные о приложении в чате imbot.app.updateИзменить данные о приложении в чате imbot.app.update

25.05.202625.05.2026| goroshckogoroshcko| Нет комментария|

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Изменить данные о приложении в чате imbot.app.update», разберем

Читать далееЧитать далее

Как использовать метод SDK crm.lead.details.configuration.set в Битрикс24Как использовать метод SDK crm.lead.details.configuration.set в Битрикс24

25.05.202625.05.2026| goroshckogoroshcko| Нет комментария|

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Как использовать метод SDK crm.lead.details.configuration.set в Битрикс24». Вы узнаете экспертные методики работы с

Читать далееЧитать далее

Как использовать метод SDK placement.list в Битрикс24Как использовать метод SDK placement.list в Битрикс24

25.05.202625.05.2026| goroshckogoroshcko| Нет комментария|

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Как использовать метод SDK placement.list в Битрикс24», разберем

Читать далееЧитать далее