Блог Горошко Андрея Bitrix24,PHP Создать новый пользовательский тип crm.type.add

Создать новый пользовательский тип crm.type.add

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Создать новый пользовательский тип crm.type.add», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Создать новый пользовательский тип crm.type.add

> Scope: crm
>
> Кто может выполнять метод: любой пользователь с административным доступом к разделу CRM

Метод создает новый смарт-процесс.

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

Название
тип
Описание
fields
[object][1]
Значения полей (подробное описание приведено ниже) для добавления нового смарт-процесса

Параметр fields

Название
тип
ОписаниеПо умолчанию
title
[string][1]
Название смарт-процесса
entityTypeId
[integer][1]
Идентификатор создаваемого смарт-процесса. Если не передавать данное поле, то оно будет сгенерировано автоматически.

Стоит учитывать, что:
1. Данный параметр является уникальны. Не получится создать два смарт-процесса с одинаковыми entityTypeId
2. Значение entityTypeId обязано быть в одном из двух диапазонов:
— четным целым числом, которое больше или равно 1030
— в диапазоне от 128 до 192

relations
[object][1]
Объект, содержащий в себе связи к другим сущностям CRM. Структура описана ниже
isUseInUserfieldEnabled
[boolean][1]
Включено ли использование смарт-процесса в пользовательском полеN
linkedUserFields
[object][1]
Набор пользовательских полей в которых должен отображаться данный смарт-процесс. Структура описана ниже{}
isAutomationEnabled
[boolean][1]
Включены ли роботы и триггерыN
isBeginCloseDatesEnabled
[boolean][1]
Включены ли поля Дата начала и Дата завершенияN
isBizProcEnabled
[boolean][1]
Включено ли использование дизайнера бизнес процессовN
isCategoriesEnabled
[boolean][1]
Включены ли свои воронки и туннели продажN
isClientEnabled
[boolean][1]
Включено ли поле Клиент. При включенной опции у смарт-процесса появляется предустановленная привязка к Контактам и КомпаниямN
isDocumentsEnabled
[boolean][1]
Включена ли печать документовN
isLinkWithProductsEnabled
[boolean][1]
Включена ли привязка товаров каталогаN
isMycompanyEnabled
[boolean][1]
Включено ли поле Реквизиты вашей компанииN
isObserversEnabled
[boolean][1]
Включено ли поле НаблюдателиN
isRecyclebinEnabled
[boolean][1]
Включено ли использование корзиныN
isSetOpenPermissions
[boolean][1]
Делать ли новые воронки доступными для всехY
isSourceEnabled
[boolean][1]
Включены ли поля Источник и Дополнительно об источникеN
isStagesEnabled
[boolean][1]
Включено ли использование своих стадий и канбанаN
isExternal
[boolean][1]
Является ли смарт-процесс вынесенным из CRM (привязанным к цифровому рабочему месту)

Параметр устарел. Для работы с цифровыми рабочими местами используйте методы crm.automatedsolution.*

-
customSectionId
[integer][1]
Идентификатор цифрового рабочего места

Параметр устарел. Для работы с цифровыми рабочими местами используйте методы crm.automatedsolution.*

-
customSections
[array][1]
Массив цифровых рабочих мест

Параметр устарел. Для работы с цифровыми рабочими местами используйте методы crm.automatedsolution.*

-

Связи relations {#relations}

Название
тип
Описание
parent
relation[]
Элементы CRM, которые будут привязаны к данному смарт-процессу
child
relation[]
Элементы CRM, к котором будет привязан данный смарт-процесс

Одна связь relation {#relation}

Название
тип
ОписаниеПо умолчанию
entityTypeId*
[integer][1]
Идентификатор системного или пользовательского типа сущности CRM-
isChildrenListEnabled
[boolean][1]
Добавлять ли связанный элемент в карточку.

Значения Y и N не работают. Необходимо передавать "true" или "false"

"false"

Привязка к пользовательским полям {#linkedUserFields}

linkedUserFields — набор полей, в которых должен отображаться этот смарт-процесс.
Данная настройка будет учитываться, только в случае передачи isUseInUserfieldEnabled = 'Y'

Название
тип
ОписаниеЗначение по умолчанию
CALENDAR_EVENT\UF_CRM_CAL_EVENT
[boolean][1]
Событие в календаре"false"
TASKS_TASK\UF_CRM_TASK
[boolean][1]
Задачи"false"
TASKS_TASK\UF_CRM_TASK
[boolean][1]
Шаблоны задач"false"

Данные параметры не поддерживают передачу в них значений Y и N. Используйте "true" или "false".

Примеры кода

Создадим смарт-процесс со следующими условиями:

  • Наиболее полное количество включенных настроек
  • Привязать Лиды, Сделки, Счета к создаваемому смарт-процессу. Каждую из привязок добавляем в карточку элементов данного смарт-процесса
  • Привязать создаваемый смарт-процесс к Контактам и Компаниям. Привязку к Контактам добавляем в карточку
  • Смарт-процесс должен отображаться в следующих полях: Событие в календаре, Задачи
  • cURL (Webhook)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields":{"title":"Смарт-процесс","entityTypeId":2024,"isAutomationEnabled":"Y","isBeginCloseDatesEnabled":"Y","isBizProcEnabled":"Y","isCategoriesEnabled":"Y","isClientEnabled":"Y","isDocumentsEnabled":"Y","isLinkWithProductsEnabled":"Y","isMycompanyEnabled":"Y","isObserversEnabled":"Y","isRecyclebinEnabled":"Y","isSetOpenPermissions":"Y","isSourceEnabled":"Y","isStagesEnabled":"Y","isUseInUserfieldEnabled":"Y","linkedUserFields":{"CALENDAR_EVENT|UF_CRM_CAL_EVENT":"true","TASKS_TASK|UF_CRM_TASK":"true"},"relations":{"parent":[{"entityTypeId":1,"isChildrenListEnabled":"true"},{"entityTypeId":2,"isChildrenListEnabled":"true"},{"entityTypeId":31,"isChildrenListEnabled":"true"}],"child":[{"entityTypeId":3,"isChildrenListEnabled":"true"},{"entityTypeId":4}]}}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/crm.type.add
  • cURL (OAuth)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"fields":{"title":"Смарт-процесс","entityTypeId":2024,"isAutomationEnabled":"Y","isBeginCloseDatesEnabled":"Y","isBizProcEnabled":"Y","isCategoriesEnabled":"Y","isClientEnabled":"Y","isDocumentsEnabled":"Y","isLinkWithProductsEnabled":"Y","isMycompanyEnabled":"Y","isObserversEnabled":"Y","isRecyclebinEnabled":"Y","isSetOpenPermissions":"Y","isSourceEnabled":"Y","isStagesEnabled":"Y","isUseInUserfieldEnabled":"Y","linkedUserFields":{"CALENDAR_EVENT|UF_CRM_CAL_EVENT":"true","TASKS_TASK|UF_CRM_TASK":"true"},"relations":{"parent":[{"entityTypeId":1,"isChildrenListEnabled":"true"},{"entityTypeId":2,"isChildrenListEnabled":"true"},{"entityTypeId":31,"isChildrenListEnabled":"true"}],"child":[{"entityTypeId":3,"isChildrenListEnabled":"true"},{"entityTypeId":4}]}},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.type.add
  • JS
    try
    {
    	const response = await $b24.callMethod(
    		'crm.type.add',
    		{
    			fields: {
    				title: "Смарт-процесс",
    				entityTypeId: 2024,
    				isAutomationEnabled: "Y",
    				isBeginCloseDatesEnabled: "Y",
    				isBizProcEnabled: "Y",
    				isCategoriesEnabled: "Y",
    				isClientEnabled: "Y",
    				isDocumentsEnabled: "Y",
    				isLinkWithProductsEnabled: "Y",
    				isMycompanyEnabled: "Y",
    				isObserversEnabled: "Y",
    				isRecyclebinEnabled: "Y",
    				isSetOpenPermissions: "Y",
    				isSourceEnabled: "Y",
    				isStagesEnabled: "Y",
    				isUseInUserfieldEnabled: "Y",
    				linkedUserFields: {
    					"CALENDAR_EVENT|UF_CRM_CAL_EVENT": "true",
    					"TASKS_TASK|UF_CRM_TASK": "true",
    				},
    				relations: {
    					parent: [
    						{
    							entityTypeId: 1,
    							isChildrenListEnabled: "true",
    						},
    						{
    							entityTypeId: 2,
    							isChildrenListEnabled: "true",
    						},
    						{
    							entityTypeId: 31,
    							isChildrenListEnabled: "true",
    							
    						},
    					],
    					child: [
    						{
    							entityTypeId: 3,
    							isChildrenListEnabled: "true",
    						},
    						{
    							entityTypeId: 4,
    						},
    					],
    				},
    			},
    		}
    	);
    	
    	const result = response.getData().result;
    	console.info(result);
    }
    catch( error )
    {
    	console.error(error);
    }
  • PHP
    try {
        $response = $b24Service
            ->core
            ->call(
                'crm.type.add',
                [
                    'fields' => [
                        'title'                     => "Смарт-процесс",
                        'entityTypeId'              => 2024,
                        'isAutomationEnabled'       => "Y",
                        'isBeginCloseDatesEnabled'  => "Y",
                        'isBizProcEnabled'          => "Y",
                        'isCategoriesEnabled'       => "Y",
                        'isClientEnabled'           => "Y",
                        'isDocumentsEnabled'        => "Y",
                        'isLinkWithProductsEnabled' => "Y",
                        'isMycompanyEnabled'        => "Y",
                        'isObserversEnabled'        => "Y",
                        'isRecyclebinEnabled'       => "Y",
                        'isSetOpenPermissions'      => "Y",
                        'isSourceEnabled'           => "Y",
                        'isStagesEnabled'           => "Y",
                        'isUseInUserfieldEnabled'   => "Y",
                        'linkedUserFields'          => [
                            "CALENDAR_EVENT|UF_CRM_CAL_EVENT" => "true",
                            "TASKS_TASK|UF_CRM_TASK"          => "true",
                        ],
                        'relations'                 => [
                            'parent' => [
                                [
                                    'entityTypeId'           => 1,
                                    'isChildrenListEnabled'  => "true",
                                ],
                                [
                                    'entityTypeId'           => 2,
                                    'isChildrenListEnabled'  => "true",
                                ],
                                [
                                    'entityTypeId'           => 31,
                                    'isChildrenListEnabled'  => "true",
                                ],
                            ],
                            'child'  => [
                                [
                                    'entityTypeId'           => 3,
                                    'isChildrenListEnabled'  => "true",
                                ],
                                [
                                    'entityTypeId'           => 4,
                                ],
                            ],
                        ],
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error adding CRM type: ' . $e->getMessage();
    }
  • BX24.js
    BX24.callMethod(
        'crm.type.add',
        {
            fields: {
               "Смарт-процесс",
                entityTypeId: 2024,
                isAutomationEnabled: "Y",
                isBeginCloseDatesEnabled: "Y",
                isBizProcEnabled: "Y",
                isCategoriesEnabled: "Y",
                isClientEnabled: "Y",
                isDocumentsEnabled: "Y",
                isLinkWithProductsEnabled: "Y",
                isMycompanyEnabled: "Y",
                isObserversEnabled: "Y",
                isRecyclebinEnabled: "Y",
                isSetOpenPermissions: "Y",
                isSourceEnabled: "Y",
                isStagesEnabled: "Y",
                isUseInUserfieldEnabled: "Y",
                linkedUserFields: {
                    "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "true",
                    "TASKS_TASK|UF_CRM_TASK": "true",
                },
                relations: {
                    parent: [
                        {
                            entityTypeId: 1,
                            isChildrenListEnabled: "true",
                        },
                        {
                            entityTypeId: 2,
                            isChildrenListEnabled: "true",
                        },
                        {
                            entityTypeId: 31,
                            isChildrenListEnabled: "true",
                            
                        },
                    ],
                    child: [
                        {
                            entityTypeId: 3,
                            isChildrenListEnabled: "true",
                        },
                        {
                            entityTypeId: 4,
                        },
                    ],
                },
            },
        },
        (result) => {
            if (result.error())
            {
                console.error(result.error());

                return;
            }

            console.info(result.data());
        },
    );
  • PHP CRest
    require_once('crest.php');

    $result = CRest::call(
        'crm.type.add',
        [
            'fields' => [
                'title' => "Смарт-процесс",
                'entityTypeId' => 2024,
                'isAutomationEnabled' => "Y",
                'isBeginCloseDatesEnabled' => "Y",
                'isBizProcEnabled' => "Y",
                'isCategoriesEnabled' => "Y",
                'isClientEnabled' => "Y",
                'isDocumentsEnabled' => "Y",
                'isLinkWithProductsEnabled' => "Y",
                'isMycompanyEnabled' => "Y",
                'isObserversEnabled' => "Y",
                'isRecyclebinEnabled' => "Y",
                'isSetOpenPermissions' => "Y",
                'isSourceEnabled' => "Y",
                'isStagesEnabled' => "Y",
                'isUseInUserfieldEnabled' => "Y",
                'linkedUserFields' => [
                    "CALENDAR_EVENT|UF_CRM_CAL_EVENT" => "true",
                    "TASKS_TASK|UF_CRM_TASK" => "true",
                ],
                'relations' => [
                    'parent' => [
                        [
                            'entityTypeId' => 1,
                            'isChildrenListEnabled' => "true",
                        ],
                        [
                            'entityTypeId' => 2,
                            'isChildrenListEnabled' => "true",
                        ],
                        [
                            'entityTypeId' => 31,
                            'isChildrenListEnabled' => "true",
                        ],
                    ],
                    'child' => [
                        [
                            'entityTypeId' => 3,
                            'isChildrenListEnabled' => "true",
                        ],
                        [
                            'entityTypeId' => 4,
                        ],
                    ],
                ],
            ],
        ]
    );

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

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

HTTP-статус: 200

{
    "result": {
        "type": {
            "id": 16,
            "createdBy": 1,
            "entityTypeId": 2024,
            "isCategoriesEnabled": "Y",
            "isStagesEnabled": "Y",
            "isBeginCloseDatesEnabled": "Y",
            "isClientEnabled": "Y",
            "isUseInUserfieldEnabled": "Y",
            "isLinkWithProductsEnabled": "Y",
            "isMycompanyEnabled": "Y",
            "isDocumentsEnabled": "Y",
            "isSourceEnabled": "Y",
            "isObserversEnabled": "Y",
            "isRecyclebinEnabled": "Y",
            "isAutomationEnabled": "Y",
            "isBizProcEnabled": "Y",
            "isSetOpenPermissions": "Y",
            "isPaymentsEnabled": "N",
            "isCountersEnabled": "N",
            "createdTime": "2024-07-05T19:47:33+02:00",
            "updatedTime": "2024-07-05T19:47:33+02:00",
            "updatedBy": 1,
            "title": "Смарт-процесс",
            "relations": {
                "parent": [
                    {
                        "entityTypeId": 3,
                        "isChildrenListEnabled": "Y",
                        "isPredefined": "Y"
                    },
                    {
                        "entityTypeId": 4,
                        "isChildrenListEnabled": "Y",
                        "isPredefined": "Y"
                    },
                    {
                        "entityTypeId": 1,
                        "isChildrenListEnabled": "Y",
                        "isPredefined": "N"
                    },
                    {
                        "entityTypeId": 2,
                        "isChildrenListEnabled": "Y",
                        "isPredefined": "N"
                    },
                    {
                        "entityTypeId": 31,
                        "isChildrenListEnabled": "Y",
                        "isPredefined": "N"
                    }
                ],
                "child": [
                    {
                        "entityTypeId": 3,
                        "isChildrenListEnabled": "Y",
                        "isPredefined": "N"
                    },
                    {
                        "entityTypeId": 4,
                        "isChildrenListEnabled": "N",
                        "isPredefined": "N"
                    }
                ]
            },
            "linkedUserFields": {
                "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "Y",
                "TASKS_TASK|UF_CRM_TASK": "Y",
                "TASKS_TASK_TEMPLATE|UF_CRM_TASK": "N"
            },
            "customSections": [],
            "customSectionId": null
        }
    },
    "time": {
        "start": 1720201651.707909,
        "finish": 1720201654.748627,
        "duration": 3.040717840194702,
        "processing": 2.71589994430542,
        "date_start": "2024-07-05T19:47:31+02:00",
        "date_finish": "2024-07-05T19:47:34+02:00",
        "operating": 0
    }
}

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

Название
тип
Описание
result
[object][1]
Корневой элемент ответа. Содержит единственный ключ type
type
type
Информация о созданном смарт-процессе
time
[time][1]
Информация о времени выполнения запроса

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

HTTP-статус: 400, 403

{
    "error": "INVALID_ARG_VALUE", 
    "error_description": "entityTypeId is out of allowed range"
}

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

СтатусКодОписаниеЗначение
400INVALID_ARG_VALUEentityTypeId is out of allowed rangeВозникает, при передаче невалидного entityTypeId
400ACCESS_DENIEDДоступ запрещенВозникает, если у пользователя нет административных прав CRM
403allowed_only_intranet_userДействие разрешено только интранет-пользователямВозникает, если пользователь не является интранет-пользователем
400100Could not find value for parameter {fields}Возникает, если не передан обязательный параметр fields
4000Выберите рабочее место, в котором будет находиться смарт-процессПри передаче isExternal = 'true', но пустом customSectionId
400CREATE_DYNAMIC_TYPE_RESTRICTEDПревышено максимальное количество смарт-процессовСоздание смарт-процесса ограничено из-за тарифа
  • [](./index)
  • [](./crm-type-update)
  • [](./crm-type-get)
  • [](./crm-type-get-by-entity-type-id)
  • [](./crm-type-list)
  • [](./crm-type-delete)
  • [](./crm-type-fields)

[1]: ../../../data-types.md

💡 Экспертное мнение и рекомендации

Ключевые выводы по теме «Создать новый пользовательский тип crm.type.add»:

Использование современных стандартов D7 при работе с crm.type.add позволяет писать чистый, масштабируемый и безопасный код. Не забывайте обрабатывать исключения (try/catch) и проверять права доступа текущего пользователя перед выполнением критических операций.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Как использовать метод SDK entity.update в Битрикс24Как использовать метод SDK entity.update в Битрикс24

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Как использовать метод SDK entity.update в Битрикс24», проанализируем

Как использовать метод SDK tasks.task.list в Битрикс24Как использовать метод SDK tasks.task.list в Битрикс24

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Как использовать метод SDK tasks.task.list в Битрикс24». Мы подготовили подробный разбор принципов работы и развернутые

Добавить счет crm.invoice.addДобавить счет crm.invoice.add

Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Добавить счет crm.invoice.add». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции. Добавить счет