Получить список полей дела crm.activity.fields

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

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

Scope: crm

Кто может выполнять метод: любой пользователь

Метод crm.activity.fields возвращает описание полей системного дела.

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

Без параметров

Примеры кода

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

 curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.fields

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.fields

// 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

// Shape of the payload returned in result (match the "response handling" section of the page)
type ActivityFieldsResult = Record<string, ActivityField>

type ActivityField = {
  type: string
  isRequired: boolean
  isReadOnly: boolean
  isImmutable: boolean
  isMultiple: boolean
  isDynamic: boolean
  title: string
  isDeprecated?: boolean
}

try {
  const response = await $b24.actions.v2.call.make<ActivityFieldsResult>({
    method: 'crm.activity.fields',
    params: {},
    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('Activity field names:', Object.keys(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 getActivityFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.activity.fields',
        params: {},
        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('Activity field names:', Object.keys(result))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getActivityFields)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.activity.fields().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.fields',
            []
        );

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

    if ($result->error()) {
        error_log($result->error());
        echo 'Error: ' . $result->error();
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error fetching CRM activity fields: ' . $e->getMessage();
}

BX24.callMethod(
    'crm.activity.fields',
    {},
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

require_once('crest.php');

$result = CRest::call(
    'crm.activity.fields',
    []
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.fields", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.activity.fields: %w", err)
}

keys, ok := b24.Keys(res.Result)
if !ok {
	return fmt.Errorf("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))

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

HTTP-статус: 200

{
    "result": {
        "ID": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "ID"
        },
        "OWNER_ID": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": true,
            "isMultiple": false,
            "isDynamic": false,
            "title": "ID владельца"
        },
        "OWNER_TYPE_ID": {
            "type": "crm_enum_ownertype",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": true,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Тип владельца"
        },
        "TYPE_ID": {
            "type": "crm_enum_activitytype",
            "isRequired": true,
            "isReadOnly": false,
            "isImmutable": true,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Тип"
        },
        "PROVIDER_ID": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "ID провайдера"
        },
        "PROVIDER_TYPE_ID": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Тип провайдера"
        },
        "PROVIDER_GROUP_ID": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Тип коннектора"
        },
        "ASSOCIATED_ENTITY_ID": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "ID связанной с делом сущности"
        },
        "SUBJECT": {
            "type": "string",
            "isRequired": true,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Тема"
        },
        "START_TIME": {
            "type": "datetime",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Начало"
        },
        "END_TIME": {
            "type": "datetime",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Срок"
        },
        "DEADLINE": {
            "type": "datetime",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Срок исполнения"
        },
        "COMPLETED": {
            "type": "char",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Выполнено"
        },
        "STATUS": {
            "type": "crm_enum_activitystatus",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Статус"
        },
        "RESPONSIBLE_ID": {
            "type": "user",
            "isRequired": true,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Ответственный"
        },
        "PRIORITY": {
            "type": "crm_enum_activitypriority",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Важность"
        },
        "NOTIFY_TYPE": {
            "type": "crm_enum_activitynotifytype",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Тип уведомлений"
        },
        "NOTIFY_VALUE": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Параметр уведомления"
        },
        "DESCRIPTION": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Описание"
        },
        "DESCRIPTION_TYPE": {
            "type": "crm_enum_contenttype",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Тип описания"
        },
        "DIRECTION": {
            "type": "crm_enum_activitydirection",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Направление"
        },
        "LOCATION": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Место"
        },
        "CREATED": {
            "type": "datetime",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Дата создания"
        },
        "AUTHOR_ID": {
            "type": "user",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Создал"
        },
        "LAST_UPDATED": {
            "type": "datetime",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Дата изменения"
        },
        "EDITOR_ID": {
            "type": "user",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Изменил"
        },
        "SETTINGS": {
            "type": "object",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Настройки"
        },
        "ORIGIN_ID": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Внешний код"
        },
        "ORIGINATOR_ID": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Внешний источник"
        },
        "RESULT_STATUS": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RESULT_STATUS"
        },
        "RESULT_STREAM": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RESULT_STREAM"
        },
        "RESULT_SOURCE_ID": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RESULT_SOURCE_ID"
        },
        "PROVIDER_PARAMS": {
            "type": "object",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Параметры провайдера"
        },
        "PROVIDER_DATA": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Данные провайдера"
        },
        "RESULT_MARK": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RESULT_MARK"
        },
        "RESULT_VALUE": {
            "type": "double",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RESULT_VALUE"
        },
        "RESULT_SUM": {
            "type": "double",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RESULT_SUM"
        },
        "RESULT_CURRENCY_ID": {
            "type": "string",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "RESULT_CURRENCY_ID"
        },
        "AUTOCOMPLETE_RULE": {
            "type": "integer",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "Автозаполнение"
        },
        "BINDINGS": {
            "type": "crm_activity_binding",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": true,
            "isDynamic": false,
            "title": "Привязки"
        },
        "COMMUNICATIONS": {
            "type": "crm_activity_communication",
            "isRequired": true,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": true,
            "isDynamic": false,
            "title": "Канал коммуникации"
        },
        "FILES": {
            "type": "diskfile",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": true,
            "isDynamic": false,
            "title": "Файлы"
        },
        "WEBDAV_ELEMENTS": {
            "type": "diskfile",
            "isRequired": false,
            "isReadOnly": false,
            "isImmutable": false,
            "isMultiple": true,
            "isDynamic": false,
            "isDeprecated": true,
            "title": "Добавленные файлы"
        },
        "IS_INCOMING_CHANNEL": {
            "type": "char",
            "isRequired": false,
            "isReadOnly": true,
            "isImmutable": false,
            "isMultiple": false,
            "isDynamic": false,
            "title": "IS_INCOMING_CHANNEL"
        }
    },
    "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 соответствуют полям объекта.

time
time

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

Обзор полей системного дела

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

Поле тип

Описание

Примечание

ID*
integer

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

Только для чтения

OWNER_ID*
integer

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

Можно изменить методом crm.activity.binding.move

OWNER_TYPE_ID*
integer

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

Неизменяемое

TYPE_ID*
crm_enum_activitytype

Тип дела

Обязательный, неизменяемый

ASSOCIATED_ENTITY_ID
integer

Целочисленный идентификатор связанной с делом сущности

Только для чтения

AUTHOR_ID*
integer

Целочисленный идентификатор пользователя, создавшего дело

AUTOCOMPLETE_RULE
integer

Целочисленный идентификатор правила, по которому сработало автозаполнение

BINDINGS
crm_activity_binding

Привязки к элементам CRM

Множественное, только для чтения

COMMUNICATIONS*
crm_activity_communication

Описание коммуникации

Множественное, обязательное

COMPLETED*
char

Флаг, говорящий завершено дело или нет (Y|N)

CREATED*
datetime

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

DEADLINE
datetime

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

Поле напрямую не устанавливается, значение берётся из START_TIME для звонка и встречи и из END_TIME для задачи

DESCRIPTION
string

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

DESCRIPTION_TYPE
crm_enum_contenttype

Тип описания

DIRECTION
crm_enum_activitydirection

Направление дела: входящее/исходящее.

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

EDITOR_ID
user

Целочисленный идентификатор пользователя, изменявшего дело

Только для чтения

END_TIME
datetime

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

FILES
diskfile

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

Множественное

LAST_UPDATED
datetime

Дата последнего обновления

Только для чтения

LOCATION
string

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

NOTIFY_TYPE
crm_enum_activitynotifytype

Тип уведомления

NOTIFY_VALUE
integer

Значение уведомления

Только для чтения

ORIGINATOR_ID
string

Идентификатор источника данных

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

ORIGIN_ID
string

Идентификатор элемента в источнике данных

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

ORIGIN_VERSION
string

Оригинальная версия

Используется для защиты данных от случайного перетирания внешней системой. Если данные были импортированы и не изменялись во внешней системе, то такие данные могут быть редактированы в CRM без опасения, что следующая выгрузка приведет к перетиранию данных

PRIORITY
crm_enum_activitypriority

Приоритет

PROVIDER_DATA
string

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

PROVIDER_GROUP_ID
string

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

PROVIDER_ID
string

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

Только для чтения

PROVIDER_TYPE_ID
string

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

Статус из справочника

PROVIDER_PARAMS
object

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

RESPONSIBLE_ID*
user

Целочисленный идентификатор пользователя, ответственного за дело

Обязательное

RESULT_CURRENCY_ID
string

RESULT_MARK
integer

RESULT_SOURCE_ID
string

RESULT_STATUS
integer

RESULT_STREAM
integer

Статистика отчётов

RESULT_SUM
double

RESULT_VALUE
double

SETTINGS
object

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

START_TIME
datetime

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

STATUS
crm_enum_activitystatus

Статус дела

SUBJECT
string

Дополнительное описание дела

Обязательное

WEBDAV_ELEMENTS
diskfile

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

Множественное. Устарел, сохраняется для совместимости

IS_INCOMING_CHANNEL
char

Флаг, говорящий дело создано из входящего канала или нет (Y/N)

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

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

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

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

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

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

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

Предыдущая
Получить расшифровку звонка
Следующая
Получить описание коммуникации