Добавить связь записи таймлайна с элементом CRM crm.timeline.bindings.bind

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

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

Scope: crm

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

Метод crm.timeline.bindings.bind добавляет связь записи таймлайна с элементом CRM. После этого запись показывается в таймлайне указанного элемента.

Связь с элементом, в котором создана запись таймлайна, появляется автоматически — отдельно вызывать метод для него не нужно.

Повторный вызов с теми же значениями OWNER_ID, ENTITY_TYPE и ENTITY_ID не создает дубликат и возвращает true. Метод не проверяет, существуют ли элемент CRM и запись таймлайна, — сверяйте идентификаторы до вызова.

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

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

Название
тип

Описание

fields*
object

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

fields: {
    "OWNER_ID": 1110,
    "ENTITY_ID": 10,
    "ENTITY_TYPE": "deal",
},

Параметр fields

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

Название
тип

Описание

OWNER_ID*
integer

Идентификатор записи таймлайна. Возьмите его из ответа метода crm.timeline.comment.add или crm.timeline.logmessage.add либо получите из списка методом crm.timeline.comment.list или crm.timeline.logmessage.list

ENTITY_ID*
integer

Идентификатор элемента CRM, с которым связывается запись таймлайна

ENTITY_TYPE*
string

Символьный код типа объекта CRM entityTypeName, с которым связывается запись таймлайна. Регистр значения не важен. Возможные значения:

  • lead — лид
  • deal — сделка
  • contact — контакт
  • company — компания
  • quote — предложение
  • smart_invoice — счет
  • order — заказ
  • activity — дело
  • invoice — счет в старом формате
  • order_payment — оплата заказа
  • order_shipment — отгрузка заказа
  • dynamic_<entityTypeId> — элемент смарт-процесса, например dynamic_128

Как устроены символьные коды типов, описано в разделе Тип объекта CRM. Подходят не все коды из этой таблицы: код реквизитов requisite метод не принимает.

Если код типа не поддерживается или смарт-процесса с таким entityTypeId в Битрикс24 нет, метод возвращает ошибку ENTITY_TYPE is not defined or invalid.

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_ID":1110,"ENTITY_ID":10,"ENTITY_TYPE":"deal"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.bindings.bind
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_ID":1110,"ENTITY_ID":10,"ENTITY_TYPE":"deal"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.bindings.bind
// 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<boolean>({
    method: 'crm.timeline.bindings.bind',
    params: {
      fields: {
        OWNER_ID: 1110,
        ENTITY_ID: 10,
        ENTITY_TYPE: 'deal',
      },
    },
    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('Binding created:', 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@2/dist/umd/index.min.js"></script>
<script>
  async function createBinding() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.timeline.bindings.bind',
        params: {
          fields: {
            OWNER_ID: 1110,
            ENTITY_ID: 10,
            ENTITY_TYPE: 'deal',
          },
        },
        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('Binding created:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', createBinding)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.timeline.bindings.bind(
        fields={
            "OWNER_ID": 1110,
            "ENTITY_ID": 10,
            "ENTITY_TYPE": "deal",
        },
    ).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.bindings.bind',
            [
                'fields' => [
                    'OWNER_ID'    => 1110,
                    'ENTITY_ID'   => 10,
                    'ENTITY_TYPE' => 'deal',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error binding timeline: ' . $e->getMessage();
}
BX24.callMethod(
    "crm.timeline.bindings.bind",
    {
        fields: {
            "OWNER_ID": 1110,
            "ENTITY_ID": 10,
            "ENTITY_TYPE": "deal",
        },
    },
    result => {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.dir(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'crm.timeline.bindings.bind',
    [
        'fields' => [
            'OWNER_ID' => 1110,
            'ENTITY_ID' => 10,
            'ENTITY_TYPE' => 'deal',
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.timeline.bindings.bind", b24.Params{
	"fields": b24.Params{
		"OWNER_ID":    1110,
		"ENTITY_ID":   10,
		"ENTITY_TYPE": "deal",
	},
})
if err != nil {
	return fmt.Errorf("crm.timeline.bindings.bind: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

HTTP-статус: 200

{
    "result": true,
    "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
boolean

Возвращает true, если связь создана или уже существовала.

Возвращает false, если у пользователя нет права на изменение элемента CRM из ENTITY_ID или связь не удалось записать. HTTP-статус ответа при этом остается 200, объект error не возвращается

time
time

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

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "OWNER_ID is not defined or invalid."
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

Пустое значение

OWNER_ID is not defined or invalid.

Не передан обязательный параметр OWNER_ID, передано нечисловое значение или число меньше единицы

400

Пустое значение

ENTITY_ID is not defined or invalid.

Не передан обязательный параметр ENTITY_ID, передано нечисловое значение или число меньше единицы

400

Пустое значение

ENTITY_TYPE is not defined or invalid.

Не передан обязательный параметр ENTITY_TYPE, передан код типа, который метод не поддерживает, или смарт-процесса с таким entityTypeId нет

400

ERROR_ARGUMENT

Wrong params.

Параметр fields передан не объектом

При отказе по правам метод возвращает false, а не ошибку.

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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