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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

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

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

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

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

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

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

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

entityTypeId*
integer

Идентификатор типа сущности, в которой будет создана запись

entityId*
integer

Идентификатор элемента сущности, в которой будет создана запись

title*
string

Заголовок записи

text*
string

Текст записи

iconCode*
string

Код иконки.

Список доступных кодов можно получить методом 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>
        
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());
            }
        );
        

Пример

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.timeline.logmessage.add(
                fields={
                    "entityTypeId": 1,
                    "entityId": 1,
                    "title": "Test title",
                    "text": "Test text message",
                    "iconCode": "info"
                },
            )
            result = bitrix_response.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}")
        
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

Название
тип

Описание

id
integer

Идентификатор записи таймлайна

created
datetime

Дата и время создания

authorId
integer

Пользователь, создавший запись

title
string

Заголовок записи

text
string

Содержимое записи

iconCode
string

Код иконки

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

ACCESS_DENIED

Доступ запрещен

OWNER_NOT_FOUND

Элемента сущности CRM с указанными entityTypeId и entityId не существует

100

Не переданы обязательные поля

0

Другие ошибки (например, фатальные)

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение