Добавить системное дело crm.activity.add

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

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

Scope: crm

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

DEPRECATED

Развитие метода остановлено. Используйте crm.activity.todo.add.

Метод crm.activity.add создает новое системное дело.

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

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

Название
тип

Описание

fields*
object

Объект значений полей дела (подробное описание). Пример структуры:

{
    "fields": {
        "OWNER_TYPE_ID": 2,
        "OWNER_ID": 102,
        "TYPE_ID": 2,
        "COMMUNICATIONS": [{"VALUE": "+79990000000"}],
        "SUBJECT": "Новый звонок"
    }
}

Поле SETTINGS.DISABLE_SENDING_MESSAGE_COPY отключает отправку копии письма адресату из MESSAGE_FROM, если указано значение Y. Пример:

{
    "fields": {
        "SETTINGS": {
            "DISABLE_SENDING_MESSAGE_COPY": "Y"
        }
    }
}

Параметр fields

Полный список и описание полей — в crm.activity.fields. Ниже приведены поля и особенности их передачи при создании дела.

Укажите элемент CRM через OWNER_TYPE_ID и OWNER_ID либо передайте корректную связь в COMMUNICATIONS. Для создания дела необходима хотя бы одна связь с элементом CRM.

Связанные элементы CRM должны существовать, а пользователь — иметь право на изменение каждого из них. В примерах замените OWNER_TYPE_ID, OWNER_ID, ENTITY_TYPE_ID и ENTITY_ID на типы и идентификаторы доступных элементов. Если в коммуникации передан VALUE, но не указаны ENTITY_TYPE_ID или ENTITY_ID, метод использует для нее OWNER_TYPE_ID и OWNER_ID.

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

Поле тип

Описание

OWNER_ID
integer

Идентификатор элемента CRM

OWNER_TYPE_ID
integer

Идентификатор типа объекта CRM

TYPE_ID
crm_enum_activitytype

Тип дела. Обязателен, если не указан PROVIDER_ID. Если указан PROVIDER_ID, а TYPE_ID не задан, метод использует тип «дело провайдера». Доступные значения описаны в справочнике типов дел.

Чтобы создать дело с типом «задача», используйте метод создания или изменения задачи и укажите элемент CRM в поле UF_CRM_TASK

COMMUNICATIONS
crm_activity_communication

Массив коммуникаций. Обязателен для звонка, встречи и письма; для дела провайдера может отсутствовать. Для звонка и встречи допускается не более одной коммуникации

COMPLETED
char

Признак завершения дела: Y — завершено, N — не завершено

DEADLINE
datetime

Дата и время срока исполнения дела. Переданное значение игнорируется: срок рассчитывает провайдер дела, а если он срок не установил, используется START_TIME

DESCRIPTION
string

Текстовое описание дела

DESCRIPTION_TYPE
crm_enum_contenttype

Тип описания

DIRECTION
crm_enum_activitydirection

Направление дела: входящее/исходящее. Актуально для звонков и писем, для встреч не используется

END_TIME
datetime

Время завершения дела

FILES
diskfile

Добавленные в дело файлы

LOCATION
string

Местоположение

NOTIFY_TYPE
crm_enum_activitynotifytype

Единица времени напоминания: 1 — минуты, 2 — часы, 3 — дни, 0 — напоминание не задано

NOTIFY_VALUE
integer

Количество единиц NOTIFY_TYPE для напоминания. Обязательно, если NOTIFY_TYPE больше 0

ORIGINATOR_ID
string

Идентификатор источника данных, используется только для привязки к внешнему источнику

ORIGIN_ID
string

Идентификатор элемента в источнике данных, используется только для привязки к внешнему источнику

PRIORITY
crm_enum_activitypriority

Приоритет

PROVIDER_DATA
string

Дополнительные данные провайдера

PROVIDER_GROUP_ID
string

Идентификатор группы провайдера

PROVIDER_ID
string

Идентификатор провайдера

PROVIDER_TYPE_ID
string

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

PROVIDER_PARAMS
object

Дополнительные параметры провайдера

RESPONSIBLE_ID
user

Идентификатор пользователя, ответственного за дело. Если не указан, метод пытается использовать ответственного элемента CRM, затем текущего пользователя

SETTINGS
object

Дополнительные настройки

START_TIME
datetime

Время начала выполнения дела

STATUS
crm_enum_activitystatus

Статус дела

SUBJECT*
string

Тема дела. Поле обязательно и не может быть пустым

WEBDAV_ELEMENTS
diskfile

Добавленные файлы. Для хранилища Диск поле устарело и сохраняется для совместимости, передавайте файлы в FILES. Для хранилища WebDAV передайте объекты с ELEMENT_ID

Варианты использования значений полей

Для дел типа e-mail:

  • если письмо не должно быть отправлено, устанавливайте параметры DIRECTION=2 и COMPLETED='N'
  • если письмо нужно пометить как завершенное, вызовите метод crm.activity.update и передайте COMPLETED='Y'

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_TYPE_ID":2,"OWNER_ID":102,"TYPE_ID":2,"COMMUNICATIONS":[{"VALUE":"+79832322323","ENTITY_ID":134,"ENTITY_TYPE_ID":3}],"SUBJECT":"Новый звонок","START_TIME":"2023-12-31T12:00:00+00:00","END_TIME":"2023-12-31T12:30:00+00:00","COMPLETED":"N","PRIORITY":3,"RESPONSIBLE_ID":1,"DESCRIPTION":"Важный звонок","DESCRIPTION_TYPE":3,"DIRECTION":2,"FILES":[{"fileData":["example.jpg","base64_encoded_content_here"]}]} }' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_TYPE_ID":2,"OWNER_ID":102,"TYPE_ID":2,"COMMUNICATIONS":[{"VALUE":"+79832322323","ENTITY_ID":134,"ENTITY_TYPE_ID":3}],"SUBJECT":"Новый звонок","START_TIME":"2023-12-31T12:00:00+00:00","END_TIME":"2023-12-31T12:30:00+00:00","COMPLETED":"N","PRIORITY":3,"RESPONSIBLE_ID":1,"DESCRIPTION":"Важный звонок","DESCRIPTION_TYPE":3,"DIRECTION":2,"FILES":[{"fileData":["example.jpg","base64_encoded_content_here"]}]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.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.activity.add',
    params: {
      fields: {
        OWNER_TYPE_ID: 2,
        OWNER_ID: 102,
        TYPE_ID: 2,
        COMMUNICATIONS: [
          { VALUE: '+79832322323', ENTITY_ID: 134, ENTITY_TYPE_ID: 3 },
        ],
        SUBJECT: 'New call',
        START_TIME: '2023-12-31T12:00:00+00:00',
        END_TIME: '2023-12-31T12:30:00+00:00',
        COMPLETED: 'N',
        PRIORITY: 3,
        RESPONSIBLE_ID: 1,
        DESCRIPTION: 'Important call',
        DESCRIPTION_TYPE: 3,
        DIRECTION: 2,
        FILES: [
          {
            fileData: [
              'example.jpg',
              'base64_encoded_content_here',
            ],
          },
        ],
      },
    },
    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('Created activity 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 addActivity() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.activity.add',
        params: {
          fields: {
            OWNER_TYPE_ID: 2,
            OWNER_ID: 102,
            TYPE_ID: 2,
            COMMUNICATIONS: [
              { VALUE: '+79832322323', ENTITY_ID: 134, ENTITY_TYPE_ID: 3 },
            ],
            SUBJECT: 'New call',
            START_TIME: '2023-12-31T12:00:00+00:00',
            END_TIME: '2023-12-31T12:30:00+00:00',
            COMPLETED: 'N',
            PRIORITY: 3,
            RESPONSIBLE_ID: 1,
            DESCRIPTION: 'Important call',
            DESCRIPTION_TYPE: 3,
            DIRECTION: 2,
            FILES: [
              {
                fileData: [
                  'example.jpg',
                  'base64_encoded_content_here',
                ],
              },
            ],
          },
        },
        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('Created activity ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.crm.activity.add(
        fields={
            "OWNER_TYPE_ID": 2,
            "OWNER_ID": 102,
            "TYPE_ID": 2,
            "COMMUNICATIONS": [
                {"VALUE": "+79832322323", "ENTITY_ID": 134, "ENTITY_TYPE_ID": 3},
            ],
            "SUBJECT": "Новый звонок",
            "START_TIME": "2023-12-31T12:00:00+00:00",
            "END_TIME": "2023-12-31T12:30:00+00:00",
            "COMPLETED": "N",
            "RESPONSIBLE_ID": 1,
            "PRIORITY": 3,
            "DESCRIPTION": "Важный звонок",
            "DESCRIPTION_TYPE": 3,
            "DIRECTION": 2,
            "FILES": [
                {"fileData": ["example.jpg", "base64_encoded_content_here"]},
            ],
        },
    ).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.activity.add',
            [
                'fields' => [
                    'OWNER_TYPE_ID'    => 2,
                    'OWNER_ID'         => 102,
                    'TYPE_ID'          => 2,
                    'COMMUNICATIONS'   => [
                        ['VALUE' => '+79832322323', 'ENTITY_ID' => 134, 'ENTITY_TYPE_ID' => 3]
                    ],
                    'SUBJECT'          => 'Новый звонок',
                    'START_TIME'       => '2023-12-31T12:00:00+00:00',
                    'END_TIME'         => '2023-12-31T12:30:00+00:00',
                    'COMPLETED'        => 'N',
                    'PRIORITY'         => 3,
                    'RESPONSIBLE_ID'   => 1,
                    'DESCRIPTION'      => 'Важный звонок',
                    'DESCRIPTION_TYPE' => 3,
                    'DIRECTION'        => 2,
                    'FILES'            => [
                        [
                            'fileData' => [
                                'example.jpg',
                                'base64_encoded_content_here'
                            ]
                        ]
                    ]
                ]
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding activity: ' . $e->getMessage();
}
BX24.callMethod(
    "crm.activity.add",
    {
        fields: {
            "OWNER_TYPE_ID": 2,
            "OWNER_ID": 102,
            "TYPE_ID": 2,
            "COMMUNICATIONS": [
                { VALUE: "+79832322323", ENTITY_ID: 134, ENTITY_TYPE_ID: 3 }
            ],
            "SUBJECT": "Новый звонок",
            "START_TIME": "2023-12-31T12:00:00+00:00", // Пример даты и времени
            "END_TIME": "2023-12-31T12:30:00+00:00", // Пример даты и времени
            "COMPLETED": "N",
            "PRIORITY": 3,
            "RESPONSIBLE_ID": 1,
            "DESCRIPTION": "Важный звонок",
            "DESCRIPTION_TYPE": 3,
            "DIRECTION": 2,
            "FILES": [
                {
                    fileData: [
                        "example.jpg", // Имя файла
                        "base64_encoded_content_here" // Контент файла в формате base64
                    ]
                }
            ]
        }
    },
    result => {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.dir(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'crm.activity.add',
    [
        'fields' => [
            'OWNER_TYPE_ID' => 2,
            'OWNER_ID' => 102,
            'TYPE_ID' => 2,
            'COMMUNICATIONS' => [
                [
                    'VALUE' => '+79832322323',
                    'ENTITY_ID' => 134,
                    'ENTITY_TYPE_ID' => 3
                ]
            ],
            'SUBJECT' => 'Новый звонок',
            'START_TIME' => '2023-12-31T12:00:00+00:00', // Пример даты и времени
            'END_TIME' => '2023-12-31T12:30:00+00:00', // Пример даты и времени
            'COMPLETED' => 'N',
            'PRIORITY' => 3,
            'RESPONSIBLE_ID' => 1,
            'DESCRIPTION' => 'Важный звонок',
            'DESCRIPTION_TYPE' => 3,
            'DIRECTION' => 2,
            'FILES' => [
                [
                    'fileData' => [
                        'example.jpg', // Имя файла
                        'base64_encoded_content_here' // Контент файла в формате base64
                    ]
                ]
            ]
        ]
    ]
);

if (isset($result['error'])) {
    echo 'Ошибка: ' . $result['error_description'];
} else {
    echo '<PRE>';
    print_r($result['result']);
    echo '</PRE>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.add", b24.Params{
	"fields": b24.Params{
		"OWNER_TYPE_ID": 2,
		"OWNER_ID":      102,
		"TYPE_ID":       2,
		"COMMUNICATIONS": []b24.Params{
			{
				"VALUE":          "+79832322323",
				"ENTITY_ID":      134,
				"ENTITY_TYPE_ID": 3,
			},
		},
		"SUBJECT":          "Новый звонок",
		"START_TIME":       "2023-12-31T12:00:00+00:00",
		"END_TIME":         "2023-12-31T12:30:00+00:00",
		"COMPLETED":        "N",
		"PRIORITY":         3,
		"RESPONSIBLE_ID":   1,
		"DESCRIPTION":      "Важный звонок",
		"DESCRIPTION_TYPE": 3,
		"DIRECTION":        2,
		"FILES": []b24.Params{
			{
				"fileData": []string{"example.jpg", "base64_encoded_content_here"},
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("crm.activity.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": 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
integer

Идентификатор дела в таймлайне

time
time

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

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

При создании исходящего завершенного письма (TYPE_ID=4, COMPLETED=Y, DIRECTION=2) метод сначала сохраняет дело, затем отправляет письмо. Если отправка завершается ошибкой Email send error. ..., дело уже создано. Перед повторным вызовом проверьте список дел, чтобы не создать дубликат.

HTTP-статус: 400

{
    "error": "",
    "error_description": "Access denied."
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

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

The field SUBJECT is not defined or empty.

Не заполнено поле SUBJECT

400

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

The field RESPONSIBLE_ID is not defined or invalid.

Не удалось определить ответственного за дело

400

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

The field TYPE_ID is not defined or invalid.

Поле TYPE_ID не задано или содержит недопустимое значение

400

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

The field COMMUNICATIONS is not defined or invalid.

Не переданы корректные коммуникации для звонка, встречи или письма

400

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

The only one communication is allowed for activity of specified type.

Для звонка или встречи передано более одной коммуникации

400

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

Could not build binding. Please ensure that owner info and communications are defined correctly.

Не удалось построить связь с элементом CRM по владельцу и коммуникациям

400

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

Entity type '<тип>' is not supported in current context

Тип связанного элемента CRM не поддерживается; <тип> — имя типа или его идентификатор в квадратных скобках

400

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

Could not find '<тип>' with ID: <ID>

Связанный элемент CRM не найден; <тип> — имя типа, <ID> — идентификатор элемента

400

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

The activity type "<тип> is not supported in current context".

Тип дела не поддерживается; <тип> — название типа дела

400

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

Email send error. Failed to load module "subscribe".

Не удалось загрузить модуль subscribe

400

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

Email send error. Invalid data.

Некорректные данные письма

400

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

Email send error. Invalid email is specified.

Указан некорректный адрес электронной почты

400

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

Email send error. "From" is not found.

Не найден отправитель письма

400

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

Email send error. "To" is not found.

Не найден получатель письма

400

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

Email send error. Failed to add posting. Please see details below.

Не удалось создать почтовую рассылку; подробности передаются в сообщении ошибки

400

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

Email send error. Failed to save posting file. Please see details below.

Не удалось сохранить файл почтовой рассылки; подробности передаются в сообщении ошибки

400

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

Email send error. Failed to update activity.

Не удалось обновить дело при отправке письма

400

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

Email send error. General error.

Общая ошибка отправки письма

400

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

The custom activity without provider is not supported in current context.

Для дела провайдера не найден провайдер

400

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

Use crm.activity.configurable.add for this activity provider

Для конфигурируемого дела используйте crm.activity.configurable.add

400

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

Access denied.

Нет прав на изменение связанного элемента CRM

400

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

Application context required.

Дело с провайдером приложения можно создать только в контексте приложения

400

ERROR_CORE

NOTIFY_VALUE is not assigned.<br>

Для выбранного типа уведомления не передано NOTIFY_VALUE

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

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

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

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