Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Зарегистрировать нового робота bizproc.robot.add», проанализируем лучшие практики и покажем, как правильно использовать bizproc.robot.add в реальных задачах.

Зарегистрировать нового робота bizproc.robot.add

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

Метод регистрирует нового робота.

Работает только в контексте приложения.

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

'NAME': {
    'ru': 'название робота',
    'en': 'robot name',
    ...
},

'DESCRIPTION': {
    'ru': 'описание робота',
    'en': 'robot description',
    ...
},

    'FILTER': {
        EXCLUDE: [ 'box' ]
    }

    'FILTER': {
        INCLUDE: [
            ['crm', 'CCrmDocumentDeal'],
            ['crm', 'CCrmDocumentLead']
        ]
    }

Объект PROPERTY {#property}

[
    'value1': 'title1',
    'value2': 'title2',
    'value3': 'title3',
    'value4': 'title4'
]

Примеры объектов

// пример для типа select
'docType': {
    'Name': {
        'ru': 'Тип документа',
        'en': 'Document type'
    },
    'Required': 'Y',
    'Multiple': 'N',
    'Default': 'PDF',
    'Type': 'select',
    'Options': {
        'pdf': 'PDF',
        'docx': 'DOCX'
    }
}

// пример для типа bool
'saveDoc': {
    'Name': {
        'ru': 'Сохранить документ',
        'en': 'Save document'
    },
    'Description': {
        'ru': 'Присвоить порядковый номер',
        'en': 'Assign a sequential number'
    },
    'Type': 'bool',
    'Required': 'Y',
    'Multiple': 'N',
    'Default': 'Y'
}

// пример для типа string
'Parameters': {
    'Name': {
        'ru': 'Параметры шаблона',
        'en': 'Template\'s parameters'
    },
    'Description': {
        'ru': 'ParamID={=ParamValue}',
        'en': 'ParamID={=ParamValue}'
    },
    'Type': 'string',
    'Required': 'N',
    'Multiple': 'Y'
}

Примеры кода

• cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"CODE":"test_robot","HANDLER":"https://your_domain/robot.php","AUTH_USER_ID":1,"USE_SUBSCRIPTION":"Y","NAME":"Отправить сообщение","PROPERTIES":{"datetime":{"Name":"Во сколько","Type":"datetime"},"text":{"Name":"Текст","Type":"text"},"user":{"Name":"Кому","Type":"user","Default":"Автор;"}},"FILTER":{"INCLUDE":[["crm","CCrmDocumentDeal"],["crm","CCrmDocumentLead"]]},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/bizproc.robot.add

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'bizproc.robot.add',
    		{
    			'CODE': 'test_robot',
    			'HANDLER': 'https://your_domain/robot.php',
    			'AUTH_USER_ID': 1,
    			'USE_SUBSCRIPTION': 'Y',
    			'NAME': 'Отправить сообщение',
    			'PROPERTIES': {
    				'datetime': {
    					'Name': 'Во сколько',
    					'Type': 'datetime'
    				},
    				'text': {
    					'Name': 'Текст',
    					'Type': 'text'
    				},
    				'user': {
    					'Name': 'Кому',
    					'Type': 'user',
    					'Default': 'Автор;'
    				}
    			},
    			'FILTER': {
    				INCLUDE: [
    					['crm', 'CCrmDocumentDeal'],
    					['crm', 'CCrmDocumentLead']
    				]
    			}
    		}
    	);
    	
    	const result = response.getData().result;
    	alert("Успешно: " + result);
    }
    catch( error )
    {
    	alert("Error: " + error);
    }

• PHP

    try {
        $result = $serviceBuilder
            ->getBizProcScope()
            ->robot()
            ->add(
                'robot_code', // string $code
                'https://example.com/handler', // string $handlerUrl
                1, // int $b24AuthUserId
                ['en' => 'Robot Name'], // array $localizedRobotName
                true, // bool $isUseSubscription
                [], // array $properties
                false, // bool $isUsePlacement
                [] // array $returnProperties
            );

        if ($result->isSuccess()) {
            print_r($result->getCoreResponse()->getResponseData()->getResult());
        } else {
            print("Failed to add robot.");
        }
    } catch (Throwable $e) {
        print("Error: " . $e->getMessage());
    }

• BX24.js

    BX24.callMethod(
        'bizproc.robot.add',
        {
            'CODE': 'test_robot',
            'HANDLER': 'https://your_domain/robot.php',
            'AUTH_USER_ID': 1,
            'USE_SUBSCRIPTION': 'Y',
            'NAME': 'Отправить сообщение',
            'PROPERTIES': {
                'datetime': {
                    'Name': 'Во сколько',
                    'Type': 'datetime'
                },
                'text': {
                    'Name': 'Текст',
                    'Type': 'text'
                },
                'user': {
                    'Name': 'Кому',
                    'Type': 'user',
                    'Default': 'Автор;'
                }
            },
            'FILTER': {
                INCLUDE: [
                    ['crm', 'CCrmDocumentDeal'],
                    ['crm', 'CCrmDocumentLead']
                ]
            }
        },
        function(result)
        {
            if(result.error())
                alert("Error: " + result.error());
            else
                alert("Успешно: " + result.data());
        }
    );

• PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'bizproc.robot.add',
        [
            'CODE' => 'test_robot',
            'HANDLER' => 'https://your_domain/robot.php',
            'AUTH_USER_ID' => 1,
            'USE_SUBSCRIPTION' => 'Y',
            'NAME' => 'Отправить сообщение',
            'PROPERTIES' => [
                'datetime' => [
                    'Name' => 'Во сколько',
                    'Type' => 'datetime'
                ],
                'text' => [
                    'Name' => 'Текст',
                    'Type' => 'text'
                ],
                'user' => [
                    'Name' => 'Кому',
                    'Type' => 'user',
                    'Default' => 'Автор;'
                ]
            ],
            'FILTER' => [
                'INCLUDE' => [
                    ['crm', 'CCrmDocumentDeal'],
                    ['crm', 'CCrmDocumentLead']
                ]
            ]
        ]
    );

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

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

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1738148752.692647,
        "finish": 1738148752.749058,
        "duration": 0.056411027908325195,
        "processing": 0.018677949905395508,
        "date_start": "2025-01-29T14:05:52+03:00",
        "date_finish": "2025-01-29T14:05:52+03:00",
        "operating_reset_at": 1738149352,
        "operating": 0
    }
}

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

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

HTTP-статус: 400

{
    "error": "ERROR_ACTIVITY_VALIDATION_FAILURE",
    "error_description": "Empty activity code!"
}

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

• [](./index)
• [](./bizproc-robot-update)
• [](./bizproc-robot-list)
• [](./bizproc-robot-delete)
• [](./bizproc-event-send)