Выполнить задание бизнес-процесса bizproc.task.complete

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

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

Scope: bizproc

Кто может выполнять метод: любой пользователь

Метод выполняет задание бизнес-процесса:

  • Утверждение документа
  • Ознакомление с документом
  • Запрос дополнительной информации
  • Запрос дополнительной информации с отклонением

Выполнить можно только свое задание.

Пользовательская документация

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

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

Название
тип

Описание

TASK_ID*
integer

Идентификатор задания.

Получить идентификатор можно методом bizproc.task.list

STATUS*
integer | string

Целевой статус задания. Возможные значения:

  • 1 или yes — да, утвержден
  • 2 или no — нет, отклонен
  • 3 или ok — ок, ознакомлен
  • 4 или cancel — отмена

Набор допустимых значений меняется в зависимости от типа задания:

  • Утверждение документа — 1 или 2
  • Ознакомление с документом — 3
  • Запрос дополнительной информации — 3
  • Запрос дополнительной информации с отклонением — 3 или 4

COMMENT
string

Комментарий пользователя.

Обязательность параметра зависит от настроек задания

FIELDS
object

Объект с описанием полей для выполнения заданий с запросом дополнительной информации в формате {"field_1": "value_1", ... "field_N": "value_N"}, где

  • field_N — символьный идентификатор поля задания
  • value_N — значение поля

Получить описания полей в задании можно методом bizproc.task.list в поле PARAMETERS.Fields ответа. Структура описания объекта поля:

"PARAMETERS": {
    "Fields": [
        {
            "Id": "field_id",
            "Type": "type",
            "Name": "name",
            "Description": "description",
            "Multiple": false,
            "Required": true,
            "Options": null,
            "Settings": null,
            "Default": "default_value"
        }
    ]
}

Id — символьный идентификатор поля задания.

В Default хранятся значения по умолчанию, которые можно передать для выполнения задания. Эти значения сконвертированы во внешнее представление:

  • для дат — в формат rest ATOM ISO-8601
  • для файлов — в ссылку на файл

В таком формате значения передаются в метод bizproc.task.complete. Затем они конвертируются во внутреннее представление:

  • даты из rest формата конвертируются во внутренний
  • файлы сохраняются и прикрепляются к бизнес-процессу

Чтобы передать значение в поле типа Файл укажите:

  • для типа Файл — base64 или массив с названием и base64
  • для типа Файл (Диск) — идентификатор файла с Диска

Подробнее о работе с файлами в статье Как загрузить файлы

Пример кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASK_ID":1501,"STATUS":3,"COMMENT":"Добавлено","FIELDS":{"contractor":"C_607","phone_number":"89991234567"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.task.complete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASK_ID":1501,"STATUS":3,"COMMENT":"Добавлено","FIELDS":{"contractor":"C_607","phone_number":"89991234567"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.task.complete
try
{
	const response = await $b24.callMethod(
		'bizproc.task.complete',
		{
			'TASK_ID': 1501,
            'STATUS': 3,
            'COMMENT': 'Добавлено',
            'FIELDS': {
				'contractor': 'C_607',
				'phone_number': '89991234567'
			}
		}
	);
	
	const result = response.getData().result;
	console.log(result);
}
catch( error )
{
	alert("Error: " + error);
}
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.bizproc.task.complete(
        task_id=1501,
        status=1,
        comment="Добавлено",
        fields={
            "contractor": "C_607",
            "phone_number": "89991234567",
        },
    ).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.task.complete',
            [
                'TASK_ID' => 1501,
                'STATUS' => 3,
                'COMMENT' => 'Добавлено',
                'FIELDS' => [
                    'contractor' => 'C_607',
                    'phone_number' => '89991234567'
                ]
            ]
        );

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

    if ($result->error()) {
        echo 'Error: ' . $result->error();
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error completing task: ' . $e->getMessage();
}
BX24.callMethod(
    'bizproc.task.complete',
    {
        'TASK_ID': 1501,
        'STATUS': 3,
        'COMMENT': 'Добавлено',
        'FIELDS': {
            'contractor': 'C_607',
            'phone_number': '89991234567'
        }
    },
    function(result)
    {
        if(result.error())
            alert("Error: " + result.error());
        else
            console.log(result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'bizproc.task.complete',
    [
        'TASK_ID' => 1501,
        'STATUS' => 3,
        'COMMENT' => 'Добавлено',
        'FIELDS' => [
            'contractor' => 'C_607',
            'phone_number' => '89991234567'
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "bizproc.task.complete", b24.Params{
	"TASK_ID": 1501,
    "STATUS":  3,
	"COMMENT": "Добавлено",
	"FIELDS": b24.Params{
		"contractor":   "C_607",
		"phone_number": "89991234567",
	},
})
if err != nil {
	return fmt.Errorf("bizproc.task.complete: %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": 1738746693.9218969,
        "finish": 1738746694.1367991,
        "duration": 0.21490216255187988,
        "processing": 0.19237995147705078,
        "date_start": "2025-02-05T12:11:33+03:00",
        "date_finish": "2025-02-05T12:11:34+03:00",
        "operating_reset_at": 1738747293,
        "operating": 0.19236207008361816
    }
}

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

Название
тип

Описание

result
boolean

Возвращает true, если задание выполнено успешно

time
time

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

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

HTTP-статус: 400

{
    "error": "ERROR_TASK_VALIDATION",
    "error_description": "incorrect STATUS"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Сообщение об ошибке

Описание

ERROR_TASK_VALIDATION

empty TASK_ID

Не указан ID задания

ERROR_TASK_VALIDATION

incorrect STATUS

Указан некорректный статус задания

ERROR_TASK_NOT_FOUND

Task not found

Не найдено задание с заданным ID

ERROR_TASK_COMPLETED

Task already completed

Задание уже выполнено ранее

ERROR_TASK_TYPE

Incorrect task type

Некорректный тип задания. Такое задание нельзя выполнить через REST

ERROR_TASK_EXECUTION

текст ошибки из задания

В процессе выполнения задания случилась указанная ошибка

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

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

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

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