Получить список комментариев crm.timeline.comment.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с доступом на чтение элементов CRM
Метод crm.timeline.comment.list получает список комментариев в таймлайне указанного элемента CRM.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Массив полей, которые необходимо выбрать: |
|
filter* |
Объект для фильтрации выбранных комментариев в формате Метод учитывает только два поля. Передавайте оба, чтобы указать элемент CRM:
Другие поля, в том числе Чтобы получить комментарии за период, выберите все комментарии элемента, например с помощью параметров |
|
order |
Объект для сортировки выбранных комментариев в формате Поддерживаются только поля Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Если параметр не передан, используется значение Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
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 |
Массив объектов комментариев |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Объект комментария
Элемент массива result содержит поля, выбранные через select, и может содержать FILES. Полное описание полей комментария приведено в разделе Список полей.
|
Название |
Описание |
|
ID |
Идентификатор комментария. В ответе передается строкой |
|
ENTITY_ID |
Идентификатор элемента CRM. В ответе передается числом |
|
ENTITY_TYPE |
Тип элемента CRM |
|
CREATED |
Дата создания комментария |
|
COMMENT |
Текст комментария |
|
AUTHOR_ID |
Идентификатор автора комментария. В ответе передается строкой |
|
FILES |
Объект файлов с ключами — идентификаторами файлов на Диске. Значения — объекты файлов. Может возвращаться независимо от |
Объект файла в FILES
|
Название |
Описание |
|
id |
Идентификатор файла на Диске |
|
date |
Дата создания файла |
|
type |
Тип содержимого: |
|
name |
Имя файла |
|
size |
Размер файла в байтах |
|
image |
Размеры изображения или превью видео: |
|
authorId |
Идентификатор пользователя, создавшего файл |
|
authorName |
Имя пользователя, создавшего файл |
|
urlPreview |
URL превью файла. Если превью недоступно — |
|
urlShow |
URL просмотра изображения или скачивания файла другого типа |
|
urlDownload |
URL скачивания файла |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Access denied."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
Пустое значение |
Access denied. |
Нет доступа к указанному элементу CRM. Ошибка также возможна, если элемент не определен из-за отсутствующих или неверных полей |
|
|
Пустое значение |
Parameter 'filter' must be array. |
Параметр |
|
|
Пустое значение |
Parameter 'order' must be array. |
Параметр |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |