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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

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

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

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

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

Название
тип

Описание

select
array

Массив полей, которые необходимо выбрать: ID, ENTITY_ID, ENTITY_TYPE, CREATED, COMMENT, AUTHOR_ID. Описание полей — в разделе Список полей. Если параметр не передан или передан пустой массив, возвращаются все перечисленные поля. Поле FILES через select не выбирается: оно возвращается независимо от select, если у комментария есть файлы и доступен модуль Диск. Укажите в select хотя бы одно из перечисленных полей — при select только с FILES массив result может оказаться пустым или неполным, хотя total больше нуля

filter*
object

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

Метод учитывает только два поля. Передавайте оба, чтобы указать элемент CRM:

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

Другие поля, в том числе CREATED, метод игнорирует: отфильтровать комментарии по ним нельзя. Если элемент CRM не определен или у пользователя нет доступа к нему, метод может вернуть ошибку Access denied.

Чтобы получить комментарии за период, выберите все комментарии элемента, например с помощью параметров select и start, и отфильтруйте их по полю CREATED на стороне приложения

order
object

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

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

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

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

start
integer

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

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

Если параметр не передан, используется значение 0 (первая страница).

Чтобы выбрать вторую страницу результатов, передайте значение 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"],"start":50}' \
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"],"start":50,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.comment.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type CommentFile = {
  id: number
  date: ISODate
  type: string
  name: string
  size: number
  image: { width: number; height: number } | false
  authorId: number
  authorName: string
  urlPreview: string | null
  urlShow: string
  urlDownload: string
}

// Shape of each CommentItem returned in result[]
type CommentItem = {
  ID: string
  ENTITY_ID: number
  ENTITY_TYPE: string
  CREATED: ISODate | null
  COMMENT: string
  AUTHOR_ID: string
  FILES?: Record<string, CommentFile>
}

try {
  // crm.timeline.comment.list returns a single page (max 50 records). For the whole result set
  // use a list helper: $b24.actions.v2.callList.make() returns every record as one
  // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
  // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
  // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
  const response = await $b24.actions.v2.call.make<CommentItem[]>({
    method: 'crm.timeline.comment.list',
    params: {
      filter: {
        ENTITY_ID: 10,
        ENTITY_TYPE: 'deal',
      },
      select: [
        'ID',
        'CREATED',
        'ENTITY_ID',
        'ENTITY_TYPE',
        'AUTHOR_ID',
        'COMMENT',
      ],
      start: 50,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Comments count:', result.length, 'first comment:', result[0])
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function fetchTimelineComments() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // crm.timeline.comment.list returns a single page (max 50 records). For the whole result set
      // use a list helper: $b24.actions.v2.callList.make() returns every record as one
      // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
      // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
      // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
      const response = await $b24.actions.v2.call.make({
        method: 'crm.timeline.comment.list',
        params: {
          filter: {
            ENTITY_ID: 10,
            ENTITY_TYPE: 'deal',
          },
          select: [
            'ID',
            'CREATED',
            'ENTITY_ID',
            'ENTITY_TYPE',
            'AUTHOR_ID',
            'COMMENT',
          ],
          start: 50,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Comments count:', result.length, 'first comment:', result[0])
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', fetchTimelineComments)
</script>

Пример

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.timeline.comment.list(
        filter={
            "ENTITY_ID": 10,
            "ENTITY_TYPE": "deal",
        },
        select=[
            "ID",
            "CREATED",
            "ENTITY_ID",
            "ENTITY_TYPE",
            "AUTHOR_ID",
            "COMMENT",
        ],
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

Пример as_list

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.timeline.comment.list(
        filter={
            "ENTITY_ID": 10,
            "ENTITY_TYPE": "deal",
        },
        select=[
            "ID",
            "CREATED",
            "ENTITY_ID",
            "ENTITY_TYPE",
            "AUTHOR_ID",
            "COMMENT",
        ],
    ).as_list().response
    result = bitrix_response.result
    for item in result:
        print(item)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

Пример as_list_fast

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.timeline.comment.list(
        filter={
            "ENTITY_ID": 10,
            "ENTITY_TYPE": "deal",
        },
        select=[
            "ID",
            "CREATED",
            "ENTITY_ID",
            "ENTITY_TYPE",
            "AUTHOR_ID",
            "COMMENT",
        ],
    ).as_list_fast(descending=True).response
    result = bitrix_response.result
    for item in result:
        print(item)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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',
                ],
                'start' => 50,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $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", 
        ],
        start: 50,
    },
    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',
        ],
        'start' => 50,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.timeline.comment.list", b24.Params{
	"filter": b24.Params{
		"ENTITY_ID":   10,
		"ENTITY_TYPE": "deal",
	},
	"select": []string{"ID", "CREATED", "ENTITY_ID", "ENTITY_TYPE", "AUTHOR_ID", "COMMENT"},
"start": 50,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.timeline.comment.list: %w", err)
}

var items []struct {
	ID         b24.ID `json:"ID"`
	EntityID   b24.ID `json:"ENTITY_ID"`
	EntityType string `json:"ENTITY_TYPE"`
	Created    string `json:"CREATED"`
	Comment    string `json:"COMMENT"`
	AuthorID   b24.ID `json:"AUTHOR_ID"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.EntityID)
}

// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
	fmt.Println("всего:", *res.Total)
}

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

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": {
                "930": {
                    "id": 930,
                    "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"
                },
                "931": {
                    "id": 931,
                    "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"
        }
    ],
    "total": 2,
    "time": {
        "start": 1715091541.642592,
        "finish": 1715091541.730599,
        "duration": 0.08800697326660156,
        "date_start": "2024-05-07T17:19:01+03:00",
        "date_finish": "2024-05-07T17:19:01+03:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
array

Массив объектов комментариев

total
integer

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

time
time

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

Объект комментария

Элемент массива result содержит поля, выбранные через select, и может содержать FILES. Полное описание полей комментария приведено в разделе Список полей.

Название
тип

Описание

ID
integer

Идентификатор комментария. В ответе передается строкой

ENTITY_ID
integer

Идентификатор элемента CRM. В ответе передается числом

ENTITY_TYPE
string

Тип элемента CRM

CREATED
datetime

Дата создания комментария

COMMENT
string

Текст комментария

AUTHOR_ID
integer

Идентификатор автора комментария. В ответе передается строкой

FILES
object

Объект файлов с ключами — идентификаторами файлов на Диске. Значения — объекты файлов. Может возвращаться независимо от select, если у комментария есть файлы и доступен модуль Диск. Если файлов нет или их данные не удалось получить, поле отсутствует

Объект файла в FILES

Название
тип

Описание

id
integer

Идентификатор файла на Диске

date
datetime

Дата создания файла

type
string

Тип содержимого: image, video или file

name
string

Имя файла

size
integer

Размер файла в байтах

image
object или false

Размеры изображения или превью видео: width — ширина в пикселях, height — высота в пикселях. Оба значения целые. Для остальных файлов — false

authorId
integer

Идентификатор пользователя, создавшего файл

authorName
string

Имя пользователя, создавшего файл

urlPreview
string или null

URL превью файла. Если превью недоступно — null

urlShow
string

URL просмотра изображения или скачивания файла другого типа

urlDownload
string

URL скачивания файла

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

Пустое значение

Access denied.

Нет доступа к указанному элементу CRM. Ошибка также возможна, если элемент не определен из-за отсутствующих или неверных полей ENTITY_ID и ENTITY_TYPE в фильтре

400

Пустое значение

Parameter 'filter' must be array.

Параметр filter передан значением, которое не является массивом или объектом

400

Пустое значение

Parameter 'order' must be array.

Параметр order передан значением, которое не является массивом или объектом

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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