Добавить лог-запись crm.timeline.logmessage.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод:
пользователь с правом на изменение элемента CRM, в который добавится запись
Метод добавляет новую лог-запись таймлайна.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей (подробное описание приведено ниже) для добавления новой лог-записи в виде структуры:
|
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityTypeId* |
Идентификатор типа сущности, в которой будет создана запись |
|
entityId* |
Идентификатор элемента сущности, в которой будет создана запись |
|
title* |
Заголовок записи |
|
text* |
Текст записи |
|
iconCode* |
Код иконки. Список доступных кодов можно получить методом crm.timeline.icon.list |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"entityTypeId":1,"entityId":1,"title":"Test title","text":"Test text message","iconCode":"info"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.logmessage.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"entityTypeId":1,"entityId":1,"title":"Test title","text":"Test text message","iconCode":"info"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.logmessage.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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type LogMessageAddResult = {
logMessage: {
id: number,
created: ISODate,
authorId: number,
title: string,
text: string,
iconCode: string,
},
}
try {
const response = await $b24.actions.v2.call.make<LogMessageAddResult>({
method: 'crm.timeline.logmessage.add',
params: {
fields: {
entityTypeId: 1,
entityId: 1,
title: 'Test title',
text: 'Test text message',
iconCode: 'info',
},
},
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(result.logMessage.id, result.logMessage.title)
}
} 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 addLogMessage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.timeline.logmessage.add',
params: {
fields: {
entityTypeId: 1,
entityId: 1,
title: 'Test title',
text: 'Test text message',
iconCode: 'info',
},
},
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(result.logMessage.id, result.logMessage.title)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addLogMessage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.timeline.logmessage.add(
fields={
"entityTypeId": 1,
"entityId": 1,
"title": "Test title",
"text": "Test text message",
"iconCode": "info",
},
).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.logmessage.add',
[
'fields' => [
'entityTypeId' => 1,
'entityId' => 1,
'title' => 'Test title',
'text' => 'Test text message',
'iconCode' => 'info',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding log message: ' . $e->getMessage();
}
BX24.callMethod(
"crm.timeline.logmessage.add",
{
fields: {
entityTypeId: 1,
entityId: 1,
title: "Test title",
text: "Test text message",
iconCode: "info",
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.timeline.logmessage.add',
[
'fields' => [
'entityTypeId' => 1,
'entityId' => 1,
'title' => 'Test title',
'text' => 'Test text message',
'iconCode' => 'info',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.timeline.logmessage.add", b24.Params{
"fields": b24.Params{
"entityTypeId": 1,
"entityId": 1,
"title": "Test title",
"text": "Test text message",
"iconCode": "info",
},
})
if err != nil {
return fmt.Errorf("crm.timeline.logmessage.add: %w", err)
}
// Метод заворачивает ответ в объект с ключом "logMessage".
raw, ok := b24.Unwrap(res.Result, "logMessage")
if !ok {
return fmt.Errorf("в ответе нет ключа logMessage")
}
var item struct {
ID b24.ID `json:"id"`
Created string `json:"created"`
AuthorID b24.ID `json:"authorId"`
Title string `json:"title"`
Text string `json:"text"`
IconCode string `json:"iconCode"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Created)
Обработка ответа
HTTP-статус: 200
{
"result": {
"logMessage": {
"id": 1,
"created": "2024-04-03T10:26:32+02:00",
"authorId": 1,
"title": "Test title",
"text": "Test note",
"iconCode": "info"
}
},
"time": {
"start": 1712132792.910734,
"finish": 1712132793.530359,
"duration": 0.6196250915527344,
"processing": 0.032338857650756836,
"date_start": "2024-04-03T10:26:32+02:00",
"date_finish": "2024-04-03T10:26:33+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Поле |
|
time |
Информация о времени выполнения запроса |
Объект logMessage
|
Название |
Описание |
|
id |
Идентификатор записи таймлайна |
|
created |
Дата и время создания |
|
authorId |
Пользователь, создавший запись |
|
title |
Заголовок записи |
|
text |
Содержимое записи |
|
iconCode |
Код иконки |
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Доступ запрещен"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
|
|
Доступ запрещен |
|
|
Элемента сущности CRM с указанными |
|
|
Не переданы обязательные поля |
|
|
Другие ошибки (например, фатальные) |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |