Блог Горошко Андрея Bitrix24,PHP Добавить лог-запись crm.timeline.logmessage.add

Добавить лог-запись crm.timeline.logmessage.add

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Добавить лог-запись crm.timeline.logmessage.add», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Добавить лог-запись crm.timeline.logmessage.add

> Scope: crm
>
> Кто может выполнять метод: пользователь с правом на изменение элемента CRM, в который добавится запись

Метод добавляет новую лог-запись таймлайна.

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

Название
тип
Описание
fields
object
Значения полей (подробное описание приведено ниже) для добавления новой лог-записи в виде структуры:

fields:
{
    entityTypeId: "значение",
    entityId: "значение",
   "значение",
    text: "значение",
    iconCode: "значение",
},

Параметр fields

Название
тип
Описание
entityTypeId
integer
Идентификатор типа сущности, в которой будет создана запись
entityId
integer
Идентификатор элемента сущности, в которой будет создана запись
title
string
Заголовок записи
text
string
Текст записи
iconCode
string
Код иконки.

Список доступных кодов можно получить методом crm.timeline.icon.list

Примеры кода

  • cURL (Webhook)
    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 (OAuth)
    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
  • JS
    try
    {
    	const response = await $b24.callMethod(
    		'crm.timeline.logmessage.add',
    		{
    			fields: {
    				entityTypeId: 1,
    				entityId: 1,
    				title: 'Test title',
    				text: 'Test text message',
    				iconCode: 'info',
    			},
    		}
    	);
    	
    	const result = response.getData().result;
    	if (result.error())
    		console.error(result.error());
    	else
    		console.dir(result);
    }
    catch( error )
    {
    	console.error('Error:', error);
    }
  • PHP
    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.js
    BX24.callMethod(
        "crm.timeline.logmessage.add",
        {
            fields: {
                entityTypeId: 1,
                entityId: 1,
               "Test title",
                text: "Test text message",
                iconCode: "info",
            },
        },
        result => {
            if (result.error())
                console.error(result.error());
            else
                console.dir(result.data());
        }
    );
  • PHP CRest
    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>';

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

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
object
Корневой элемент ответа.

Поле result содержит объект logMessage

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

Объект logMessage {#logMessage}

Название
тип
Описание
id
integer
Идентификатор записи таймлайна
created
datetime
Дата и время создания
authorId
integer
Пользователь, создавший запись
title
string
Заголовок записи
text
string
Содержимое записи
iconCode
string
Код иконки

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

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "Доступ запрещен"
}

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

КодОписание
ACCESS_DENIEDДоступ запрещен
OWNER_NOT_FOUNDЭлемента сущности CRM с указанными entityTypeId и entityId не существует
100Не переданы обязательные поля
0Другие ошибки (например, фатальные)
  • [](./crm-timeline-logmessage-get)
  • [](./crm-timeline-logmessage-list)
  • [](./crm-timeline-logmessage-delete)

💡 Экспертное мнение и рекомендации

Практические рекомендации:

  • При написании кастомных компонентов для «Добавить лог-запись crm.timeline.logmessage.add» всегда разделяйте бизнес-логику и представление (шаблон).
  • Используйте отладку SQL-запросов через конструкцию $wpdb->last_query или стандартный трекер Битрикса, чтобы контролировать нагрузку.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Получить список полей товарных позиций crm.item.productrow.fieldsПолучить список полей товарных позиций crm.item.productrow.fields

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Получить список полей товарных позиций crm.item.productrow.fields». Мы подготовили подробный разбор принципов работы и развернутые примеры

Получить информацию о текущем пользователе user.currentПолучить информацию о текущем пользователе user.current

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Получить информацию о текущем пользователе user.current», проанализируем лучшие

Обновить обработчик службы доставки sale.delivery.handler.updateОбновить обработчик службы доставки sale.delivery.handler.update

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Обновить обработчик службы доставки sale.delivery.handler.update». Вы узнаете экспертные методики работы с sale.delivery.handler.update и