crm.timeline.comment.add
Добавить комментарий
Описание
Метод добавляет новое дело типа «Комментарий» в таймлайн.
Параметры
fields
object
обязательный
Значения полей (подробное описание приведено ниже) для добавления нового дела типа «Комментарий» в виде структуры:
fields:
{
"ENTITY_ID": 'значение',
"ENTITY_TYPE": 'значение',
"COMMENT": 'значение',
"FILES": [
[
"название файла",
"содержимое файла"
],
[
"название файла",
"содержимое файла"
],
]
}
Содержимое файла передается в виде base64-строки
С версии crm 23.100.0 метод принимает только параметры с ключом fields в нижнем регистре. Другие недокументированные варианты (Fields, FIELDS, arFields) не принимаются.
Параметр fields
ENTITY_ID
integer
обязательный
ID элемента, к которому привязан комментарий.
Значение можно получить методом crm.item.list или при создании элемента с помощью crm.item.add
ENTITY_TYPE
string
обязательный
Идентификатор системного или пользовательского типа объекта CRM, к элементу которого привязан комментарий. Например: lead, deal, contact, company, order, dynamic_1046
COMMENT
string
обязательный
Текст комментария
FILES
attached_diskfile
необязательный
Список файлов. Массив значений, описанный по правилам
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ENTITY_ID":10,"ENTITY_TYPE":"deal","COMMENT":"New comment was added","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.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"ENTITY_ID":10,"ENTITY_TYPE":"deal","COMMENT":"New comment was added","FILES":[["1.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="],["2.gif","R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="]]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.comment.add
// 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.add',
params: {
fields: {
ENTITY_ID: 10,
ENTITY_TYPE: 'deal',
COMMENT: 'New comment was added',
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('Added 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 addTimelineComment() {
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.add',
params: {
fields: {
ENTITY_ID: 10,
ENTITY_TYPE: 'deal',
COMMENT: 'New comment was added',
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('Added comment ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addTimelineComment)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.timeline.comment.add(
fields={
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
"COMMENT": "New comment was added",
"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.add',
[
'fields' => [
'ENTITY_ID' => 10,
'ENTITY_TYPE' => 'deal',
'COMMENT' => 'New comment was added',
'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 adding timeline comment: ' . $e->getMessage();
}
BX24.callMethod(
"crm.timeline.comment.add",
{
fields:
{
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
"COMMENT": "New comment was added",
"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.add',
[
'fields' => [
'ENTITY_ID' => 10,
'ENTITY_TYPE' => 'deal',
'COMMENT' => 'New comment was added',
'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.add", b24.Params{
"fields": b24.Params{
"ENTITY_ID": 10,
"ENTITY_TYPE": "deal",
"COMMENT": "New comment was added",
"FILES": []any{
[]string{"1.gif", "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="},
[]string{"2.gif", "R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="},
},
},
})
if err != nil {
return fmt.Errorf("crm.timeline.comment.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
Ответ
HTTP-статус: 200
{
"result": 999,
"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
integer
Возвращает целочисленный идентификатор добавленного комментария
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "NOT_FOUND",
"error_description": "Not found."
}
| Код | Описание | Значение |
|---|---|---|
OWNER_NOT_FOUND |
Владелец элемента не найден | |
ACCESS_DENIED |
Недостаточно прав | |
NOT_FOUND |
Элемент не найден | |
INVALID_ARG_VALUE |
Пустой коментарий | |
100 |
Не переданы обязательные поля |

