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

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
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.activity.type.add",
        		{
        			fields:
        			{
        				"TYPE_ID": '1C',
        				"NAME": "Дело 1C",
        				'ICON_FILE': document.getElementById('type-icon'), // file input node
        				"IS_CONFIGURABLE_TYPE": "N"
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(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>';
        

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

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

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

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

Код

Описание

ACCESS_DENIED

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

Access denied! Application context required

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

INVALID_ARG_VALUE

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

INVALID_ARG_VALUE

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

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

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

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

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

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

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