Добавить пользовательский тип дела crm.activity.type.add

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

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

Scope: crm

Кто может выполнять метод: администратор

Метод crm.activity.type.add регистрирует пользовательский тип дела с указанием названия и иконки.

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

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

Название
тип

Описание

fields*
object

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

fields:
{
    "TYPE_ID": 'значение',
    "NAME": 'значение',
    "ICON_FILE": 'значение',
    "IS_CONFIGURABLE_TYPE": 'значение',
}

Подробное описание приведено ниже

Параметр fields

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

Название
тип

Описание

TYPE_ID*
string

Строковое значение типа дела, например 1C. При создании дела это поле PROVIDER_TYPE_ID

NAME
string

Название типа дела, например Дело 1с для сделки. По умолчанию пустая строка

ICON_FILE
attached_diskfile

Файл иконки типа дела, описанный по правилам

IS_CONFIGURABLE_TYPE
string

Значение по умолчанию - N. Значение Y - признак того, что тип будет использоваться для конфигурируемых дел

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":"1C","NAME":"Дело 1C","ICON_FILE":"@type-icon","IS_CONFIGURABLE_TYPE":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.type.add

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"OWNER_TYPE_ID":1,"OWNER_ID":selectedEntityId,"PROVIDER_ID":"REST_APP","PROVIDER_TYPE_ID":"1C","SUBJECT":"Новое дело","COMPLETED":"N","RESPONSIBLE_ID":1,"DESCRIPTION":"Описание нового дела"},"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<boolean>({
    method: 'crm.activity.type.add',
    params: {
      fields: {
        TYPE_ID: '1C',
        NAME: '1C activity',
        ICON_FILE: document.getElementById('type-icon'), // file input node
        IS_CONFIGURABLE_TYPE: 'N',
      },
    },
    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 type added:', 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 addActivityType() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.activity.type.add',
        params: {
          fields: {
            TYPE_ID: '1C',
            NAME: '1C activity',
            ICON_FILE: document.getElementById('type-icon'), // file input node
            IS_CONFIGURABLE_TYPE: 'N',
          },
        },
        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 type added:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.crm.activity.type.add(
        fields={
            "TYPE_ID": "CUSTOM_CALL",
            "NAME": "Custom call",
            "ICON_FILE": {
                "fileData": [
                    "activity-type.svg",
                    "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPjwvc3ZnPg==",
                ],
            },
            "IS_CONFIGURABLE_TYPE": "N",
        },
    ).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.type.add',
            [
                'fields' => [
                    'TYPE_ID'            => '1C',
                    'NAME'               => 'Дело 1C',
                    'ICON_FILE'          => $_FILES['type-icon'], // file input node
                    'IS_CONFIGURABLE_TYPE' => 'N',
                ],
            ]
        );

    $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 adding activity type: ' . $e->getMessage();
}
BX24.callMethod(
    "crm.activity.type.add",
    {
        fields:
        {
            "TYPE_ID": '1C',
            "NAME": "Дело 1C",
            'ICON_FILE': document.getElementById('type-icon'), // file input node
            "IS_CONFIGURABLE_TYPE": "N"
        }
    }, result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

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

BX24.callMethod(
    'crm.activity.add',
    {
        fields:
        {
            "OWNER_TYPE_ID": 1,
            "OWNER_ID": selectedEntityId,
            "PROVIDER_ID": 'REST_APP',
            "PROVIDER_TYPE_ID": '1C',
            "SUBJECT": "Новое дело",
            "COMPLETED": "N",
            "RESPONSIBLE_ID": 1,
            "DESCRIPTION": "Описание нового дела"
        }
    }, result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'crm.activity.type.add',
    [
        'fields' => [
            'TYPE_ID' => '1C',
            'NAME' => 'Дело 1C',
            'ICON_FILE' => $_FILES['type-icon'], // Assuming file input is handled
            'IS_CONFIGURABLE_TYPE' => 'N'
        ]
    ]
);

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

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

require_once('crest.php');

$result = CRest::call(
   'crm.activity.add',
   [
       'fields' => [
           'OWNER_TYPE_ID' => 1,
           'OWNER_ID' => $selectedEntityId, // Assuming this variable is defined
           'PROVIDER_ID' => 'REST_APP',
           'PROVIDER_TYPE_ID' => '1C',
           'SUBJECT' => 'Новое дело',
           'COMPLETED' => 'N',
           'RESPONSIBLE_ID' => 1,
           'DESCRIPTION' => 'Описание нового дела'
       ]
   ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.type.add", b24.Params{
	"fields": b24.Params{
		"TYPE_ID":              "1C",
		"NAME":                 "Дело 1C",
		"ICON_FILE":            "@type-icon",
		"IS_CONFIGURABLE_TYPE": "N",
	},
})
if err != nil {
	return fmt.Errorf("crm.activity.type.add: %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": 1724068028.331234,
        "finish": 1724068028.726591,
        "duration": 0.3953571319580078,
        "processing": 0.13033390045166016,
        "date_start": "2025-01-21T13:47:08+02:00",
        "date_finish": "2025-01-21T13:47:08+02:00",
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
boolean

Корневой элемент ответа. Содержит:

  • true — в случае успеха
  • false — в случае неудачи (произошла ошибка)

time
time

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

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

HTTP-статус: 400

{
    "error": "NOT_FOUND",
    "error_description": "Not found."
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

ACCESS_DENIED

Недостаточно прав для выполнения операции

Access denied! Application context required

Метод работает только в контексте приложений

Admin permissions required

Метод доступен только администратору

INVALID_ARG_VALUE

Не заполнено обязательное поле TYPE_ID

INVALID_ARG_VALUE

Пользовательский тип дела с указанным TYPE_ID уже существует

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

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

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

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