Обновить комментарий crm.timeline.comment.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: автор комментария с правом изменения связанного элемента CRM
Метод crm.timeline.comment.update обновляет комментарий в таймлайне.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Целочисленный идентификатор комментария (например, |
|
fields* |
Значения полей (подробное описание приведено ниже) для обновления комментария. Пример тела запроса:
Важно С версии CRM 23.100.0 метод принимает параметр |
|
ownerTypeId |
Целочисленный идентификатор типа объекта CRM, к которому привязан комментарий (например, |
|
ownerId |
Целочисленный идентификатор элемента CRM, к которому привязан комментарий (например, |
Передавайте ownerTypeId и ownerId вместе. Если хотя бы один из параметров не передан, метод определит оба по привязкам комментария и выберет первую привязку, для которой у пользователя есть право изменения элемента CRM. Если доступной привязки нет, метод вернет ошибку ACCESS_DENIED.
Важно
Если комментарий привязан к нескольким элементам CRM, метод не меняет исходный комментарий. Он создает новый комментарий с тем же автором и датой создания, привязывает его только к выбранному элементу и снимает с исходного комментария привязку к этому элементу. У остальных элементов остается исходный текст. Метод возвращает идентификатор нового комментария, а в обработчики приходят события onCrmTimelineCommentAdd и onCrmTimelineCommentUpdate с этим идентификатором.
Параметр fields
Полный справочник полей доступен в описании метода crm.timeline.comment.fields. При обновлении учитывайте следующие требования.
Обязательные параметры отмечены *
|
Название |
Описание |
|
COMMENT* |
Текст комментария. Не должен быть пустым после удаления пробелов, табуляций и переводов строк в начале и в конце. Передавайте при каждом обновлении, в том числе при изменении файлов |
|
FILES |
Список файлов. Массив значений, описанный по правилам. При обновлении только |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999,"fields":{"COMMENT":"Comment was changed","FILES":[["1.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="],["2.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="]]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.comment.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":999,"fields":{"COMMENT":"Comment was changed","FILES":[["1.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="],["2.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="]]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.comment.update
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'crm.timeline.comment.update',
params: {
id: 999,
fields: {
COMMENT: 'Comment was changed',
FILES: [
['1.gif', 'R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=='],
['2.gif', 'R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=='],
],
},
},
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('Updated comment id:', result)
}
} 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 updateTimelineComment() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.timeline.comment.update',
params: {
id: 999,
fields: {
COMMENT: 'Comment was changed',
FILES: [
['1.gif', 'R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=='],
['2.gif', 'R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=='],
],
},
},
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('Updated comment id:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateTimelineComment)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.timeline.comment.update(
bitrix_id=999,
fields={
"COMMENT": "Comment was changed",
"FILES": [
[
"1.gif",
"R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==",
],
[
"2.gif",
"R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==",
],
],
},
).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}")
try {
$response = $b24Service
->core
->call(
'crm.timeline.comment.update',
[
'id' => 999,
'fields' => [
'COMMENT' => 'Comment was changed',
'FILES' => [
['1.gif', 'R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=='],
['2.gif', 'R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=='],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating timeline comment: ' . $e->getMessage();
}
BX24.callMethod(
"crm.timeline.comment.update",
{
id: 999,
fields:
{
"COMMENT": "Comment was changed",
"FILES": [
[
"1.gif",
"R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="
],
[
"2.gif",
"R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="
],
]
}
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.timeline.comment.update',
[
'id' => 999,
'fields' => [
'COMMENT' => 'Comment was changed',
'FILES' => [
["1.gif", "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="],
["2.gif", "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="]
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.timeline.comment.update", b24.Params{
"id": 999,
"fields": b24.Params{
"COMMENT": "Comment was changed",
"FILES": []any{
[]string{"1.gif", "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="},
[]string{"2.gif", "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="},
},
},
})
if err != nil {
return fmt.Errorf("crm.timeline.comment.update: %w", err)
}
var value b24.ID
if err := json.Unmarshal(res.Result, &value); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("результат:", value)
Обработка ответа
HTTP-статус: 200
{
"result": 999,
"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 |
Идентификатор обновленного комментария. Если комментарий был привязан к нескольким элементам CRM, возвращается идентификатор нового комментария |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "NOT_FOUND",
"error_description": "Элемент не найден"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Owner was not found |
|
|
|
|
Доступ запрещен |
Пользователь не является автором комментария или не имеет права изменять связанный элемент CRM |
|
|
|
Элемент не найден |
Комментарий не найден, у него нет привязок или указанный элемент CRM не связан с комментарием |
|
|
|
Could not create comment |
Комментарий привязан к нескольким элементам CRM, и создать новый комментарий для выбранного элемента не удалось |
|
|
|
Empty comment message |
Текст комментария не передан или пуст после удаления пробелов, табуляций и переводов строк в начале и в конце |
|
|
|
Could not find value for parameter |
Не передан обязательный параметр |
|
|
|
Could not find value for parameter |
Не передан обязательный параметр |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |