Запустить бизнес-процесс bizproc.workflow.start

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

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

Scope: bizproc

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

Метод bizproc.workflow.start запускает новый бизнес-процесс.

Запустить бизнес-процесс используя REST можно только на платных тарифах, demo лицензиях и лицензиях NFR.

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

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

Название
тип

Описание

TEMPLATE_ID*
integer

Идентификатор шаблона бизнес-процесса

DOCUMENT_ID*
array

Идентификатор документа для запуска бизнес-процесса в формате [модуль, объект, ID_элемента].

Примеры записей для разных вариантов документов:

  • Лид — ['crm', 'CCrmDocumentLead', 'LEAD_777']
  • Компания — ['crm', 'CCrmDocumentCompany', 'COMPANY_777']
  • Контакт — ['crm', 'CCrmDocumentContact', 'CONTACT_777']
  • Сделка — ['crm', 'CCrmDocumentDeal', 'DEAL_777']
  • Коммерческое предложение — ['crm', 'Bitrix\Crm\Integration\BizProc\Document\Quote', 'QUOTE_777']
  • Файл диска — ['disk', 'Bitrix\Disk\BizProcDocument', '777']
  • Документ процессов в ленте новостей — ['lists', 'BizprocDocument', '777']
  • Документ списков — ['lists', 'Bitrix\Lists\BizprocDocumentLists', '777']
  • Элемент смарт-процесса — ['crm', 'Bitrix\Crm\Integration\BizProc\Document\Dynamic', 'DYNAMIC_147_1'], где 147 — это ID смарт-процесса, 1 — ID элемента смарт-процесса
  • Счет — ['crm', 'Bitrix\Crm\Integration\BizProc\Document\SmartInvoice', 'SMART_INVOICE_3']

PARAMETERS
object

Значения параметров шаблона бизнес-процесса.

Используется, если у шаблона есть параметры.

Для передачи значения в параметр типа «Привязка к пользователю» используйте запись вида user_ID. Например:

PARAMETERS: {
    'resp_employee': user_14 // ID сотрудника — 14
}

Примеры кода

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TEMPLATE_ID":1,"DOCUMENT_ID":["crm","CCrmDocumentLead","LEAD_1"],"PARAMETERS":{"Parameter1":"user_1"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.workflow.start

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TEMPLATE_ID":1,"DOCUMENT_ID":["crm","CCrmDocumentLead","LEAD_1"],"PARAMETERS":{"Parameter1":"user_1"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.workflow.start

try
{
	const response = await $b24.callMethod(
		'bizproc.workflow.start',
		{
			TEMPLATE_ID: 1,
			DOCUMENT_ID: [
				'crm',
				'CCrmDocumentLead',
				'LEAD_1'
			],
			PARAMETERS: {
				'Parameter1': 'user_1'
			},
		}
	);
	
	const result = response.getData().result;
	console.log('response', result.answer);
	if (result.error())
		alert("Error: " + result.error());
	else
		console.log(result);
}
catch( error )
{
	console.error('Error:', error);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.bizproc.workflow.start(
        template_id=1,
        document_id=(
            "crm",
            "CCrmDocumentLead",
            "LEAD_1",
        ),
        parameters={
            "Parameter1": "user_1",
        },
    ).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(
            'bizproc.workflow.start',
            [
                'TEMPLATE_ID' => 1,
                'DOCUMENT_ID' => [
                    'crm',
                    'CCrmDocumentLead',
                    'LEAD_1'
                ],
                'PARAMETERS' => [
                    'Parameter1' => 'user_1'
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error starting workflow: ' . $e->getMessage();
}

BX24.callMethod(	
    'bizproc.workflow.start',
    {
        TEMPLATE_ID: 1,
        DOCUMENT_ID: [
            'crm',
            'CCrmDocumentLead',
            'LEAD_1'
        ],
        PARAMETERS: {
            'Parameter1': 'user_1'
        },
    },
    function(result) {
        console.log('response', result.answer);
        if(result.error())
            alert("Error: " + result.error());
        else
        console.log(result.data());
    }
);

require_once('crest.php');

$result = CRest::call(
    'bizproc.workflow.start',
    [
        'TEMPLATE_ID' => 1,
        'DOCUMENT_ID' => [
            'crm',
            'CCrmDocumentLead',
            'LEAD_1'
        ],
        'PARAMETERS' => [
            'Parameter1' => 'user_1'
        ]
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "bizproc.workflow.start", b24.Params{
	"TEMPLATE_ID": 1,
	"DOCUMENT_ID": []string{"crm", "CCrmDocumentLead", "LEAD_1"},
	"PARAMETERS": b24.Params{
		"Parameter1": "user_1",
	},
})
if err != nil {
	return fmt.Errorf("bizproc.workflow.start: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

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

HTTP-статус: 200

{
    "result": "66e81a641752f8.56521481",
    "time": {
        "start": 1726476060.581428,
        "finish": 1726476060.813776,
        "duration": 0.23234796524047852,
        "processing": 0.002630949020385742,
        "date_start": "2024-09-16T08:41:00+00:00",
        "date_finish": "2024-09-16T08:41:00+00:00",
        "operating_reset_at": 1726476660,
        "operating": 0,
    },
}

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

Название
тип

Описание

result
string

Корневой элемент ответа.

Возвращает идентификатор запущенного бизнес-процесса

time
time

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

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

HTTP-статус: 400

{
    "error": "ERROR_WRONG_WORKFLOW_ID",
    "error_description": "Empty TEMPLATE_ID",
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

ERROR_WRONG_WORKFLOW_ID

Empty TEMPLATE_ID

Передали пустой входной параметр TEMPLATE_ID

400

ERROR_WRONG_WORKFLOW_ID

Template not found

Не был найден шаблон бизнес-процесса по переданному значению TEMPLATE_ID

400

Пустое значение

Wrong DOCUMENT_ID!

Передан неправильный DOCUMENT_ID

400

Пустое значение

Incorrect document type!

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

400

Пустое значение

Template type and DOCUMENT_ID mismatch!

Тип документа в шаблоне и вычисленный по DOCUMENT_ID тип документа не совпадают.

Попытка запустить шаблон не на той сущности, для которой он был создан

403

ACCESS_DENIED

Access denied!

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

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

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

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

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

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