Добавить новое действие bizproc.activity.add

Scope: bizproc

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

Добавляет новое действие для использования в бизнес-процессах.

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

Каждый документ генерирует свой набор типов полей. Например, в CRM есть поле типа Адрес UF:address. Чтобы использовать этот тип поля в своих действиях, укажите тип документа CRM в DOCUMENT_TYPE и опишите свойства типа в PROPERTIES.

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

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

Название
тип

Описание

CODE*
string

Внутренний идентификатор действия. Является уникальным в рамках приложения.

Допустимые символы — a-z, A-Z, 0-9, точка, дефис и нижнее подчеркивание _

HANDLER*
string

URL, на который действие будет отправлять данные через сервер очередей bitrix24.

В ссылке должен быть тот же домен, на котором установлено приложение

AUTH_USER_ID
integer

Идентификатор пользователя, токен которого будет передан приложению

USE_SUBSCRIPTION
boolean

Должно ли действие ожидать ответа от приложения. Возможные значения:

  • Y — да
  • N — нет

NAME*
string | object

Название действия.

Может быть строкой или ассоциативным массивом локализированных строк вида:

'NAME': {
            'ru': 'название действия',
            'en': 'action name',
            ...
        },

DESCRIPTION
string | object

Описание действия.

Может быть строкой или ассоциативным массивом локализированных строк вида:

'DESCRIPTION': {
            'ru': 'описание действия',
            'en': 'action description',
            ...
        },

PROPERTIES
object

Объект с параметрами действия. Содержит объекты, каждый из которых описывает параметр действия.

Системное название параметра должно начинаться с буквы и может содержать символы a-z, A-Z, 0-9 и нижнее подчеркивание _

RETURN_PROPERTIES
object

Объект с дополнительными результатами действия. Содержит объекты, каждый из которых описывает параметр действия.

Параметр управляет возможностью действия ожидать ответа приложения и работать с данными, которые придут в ответе.

Системное название параметра должно начинаться с буквы и может содержать символы a-z, A-Z, 0-9 и нижнее подчеркивание _

DOCUMENT_TYPE
array

Тип документа, который будет определять типы данных для параметров PROPERTIES и RETURN_PROPERTIES. Состоит из трех элементов типа строка:

  • идентификатор модуля
  • идентификатор объекта
  • тип документа

Возможные варианты значений:

  • Модуль CRM
    ['crm', 'CCrmDocumentLead', 'LEAD'] — лиды
    ['crm', 'CCrmDocumentContact', 'CONTACT'] — контакты
    ['crm', 'CCrmDocumentCompany', 'COMPANY'] — компании
    ['crm', 'CCrmDocumentDeal', 'DEAL'] — сделки
    ['crm', 'Bitrix\Crm\Integration\BizProc\Document\Quote', 'QUOTE'] — коммерческие предложения
    ['crm', 'Bitrix\Crm\Integration\BizProc\Document\SmartInvoice', 'SMART_INVOICE'] — счета
    ['crm', 'Bitrix\Crm\Integration\BizProc\Document\Dynamic', 'DYNAMIC_XXX'] — смарт-процессы, где XXX — идентификатор смарт-процесса

  • Модуль Списки
    ['lists', 'BizprocDocument', 'iblock_XXX'] — процессы в ленте новостей, где XXX — идентификатор информационного блока
    ['lists', 'Bitrix\Lists\BizprocDocumentLists', 'iblock_XXX'] — списки в группах, где XXX — идентификатор информационного блока

  • Модуль Диск
    ['disk', 'Bitrix\Disk\BizProcDocument', 'STORAGE_XXX'], где XXX — идентификатор хранилища

FILTER
object

Объект с правилами ограничения действия по типу документа и редакции.

Может содержать ключи:

  • INCLUDE — массив правил, где действие будет отображено
  • EXCLUDE — массив правил, где действие будет скрыто

Каждое правило в массиве может быть строкой или массивом типа документа в полном или частичном варианте.

Чтобы ограничить действие по редакции Битрикс24 укажите:

  • b24 — для облака
  • box — для коробки

Примеры:

  1. Исключить действие для коробочного Битрикс24 
    FILTER: {
            EXCLUDE: [ 'box' ]
        }
  2. Отображать действие только для модуля Списки 
    FILTER: {
            INCLUDE: [
                ['lists']
            ]
        }
  3. Отображать действие только для модуля Списки и сделок из CRM 
    FILTER: {
            INCLUDE: [
                ['lists'],
                ['crm', 'CCrmDocumentDeal']
            ]
        }

USE_PLACEMENT
boolean

Дает возможность открывать дополнительные настройки действия в слайдере приложения. Возможные значения:

  • Y — да
  • N — нет

PLACEMENT_HANDLER*
string

URL обработчика встройки на стороне приложения. Обязательное, если USE_PLACEMENT = 'Y'

Объект PROPERTY

Название
тип

Описание

Name
string | object

Наименование параметра

Description
string | object

Описание параметра

Type
string

Тип параметра. Базовые значения:

  • bool — да или нет
  • date — дата
  • datetime — дата и время
  • double — число
  • int — целое число
  • select — список
  • string — строка
  • text — текст
  • user — пользователь

Options
array

Массив значений параметра типа список 'TYPE': select' вида:

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

Required
boolean

Обязательность параметра. Возможные значения:

  • Y — да
  • N — нет

Multiple
boolean

Множественность параметра. Возможные значения:

  • Y — да
  • N — нет

Default
any

Значение параметра по умолчанию

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

// пример для типа 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 -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"md5_action","HANDLER":"https://your_domain/ping.php","AUTH_USER_ID":1,"USE_SUBSCRIPTION":"Y","NAME":{"ru":"MD5 генератор","en":"MD5 generator"},"DESCRIPTION":{"ru":"Действие возвращает MD5 хеш от входящего параметра","en":"Activity returns MD5 hash of input parameter"},"PROPERTIES":{"inputString":{"Name":{"ru":"Входящая строка","en":"Input string"},"Description":{"ru":"Введите строку, которую вы хотите хешировать","en":"Input string for hashing"},"Type":"string","Required":"Y","Multiple":"N","Default":"{=Document:NAME}"}},"RETURN_PROPERTIES":{"outputString":{"Name":{"ru":"MD5","en":"MD5"},"Type":"string","Multiple":"N","Default":null}},"DOCUMENT_TYPE":["lists","BizprocDocument","iblock_164"],"FILTER":{"INCLUDE":[["lists"]]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/bizproc.activity.add
        
try
        {
        	const response = await $b24.callMethod(
        		'bizproc.activity.add',
        		{
        			'CODE': 'md5_action',
        			'HANDLER': 'https://your_domain/ping.php',
        			'AUTH_USER_ID': 1,
        			'USE_SUBSCRIPTION': 'Y',
        			'NAME': {
        				'ru': 'MD5 генератор',
        				'en': 'MD5 generator'
        			},
        			'DESCRIPTION': {
        				'ru': 'Действие возвращает MD5 хеш от входящего параметра',
        				'en': 'Activity returns MD5 hash of input parameter'
        			},
        			'PROPERTIES': {
        				'inputString': {
        					'Name': {
        						'ru': 'Входящая строка',
        						'en': 'Input string'
        					},
        					'Description': {
        						'ru': 'Введите строку, которую вы хотите хешировать',
        						'en': 'Input string for hashing'
        					},
        					'Type': 'string',
        					'Required': 'Y',
        					'Multiple': 'N',
        					'Default': '{=Document:NAME}'
        				}
        			},
        			'RETURN_PROPERTIES': {
        				'outputString': {
        					'Name': {
        						'ru': 'MD5',
        						'en': 'MD5'
        					},
        					'Type': 'string',
        					'Multiple': 'N',
        					'Default': null
        				}
        			},
        			'DOCUMENT_TYPE': ['lists', 'BizprocDocument', 'iblock_164'],
        			'FILTER': {
        				INCLUDE: [
        					['lists']
        				]
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	alert("Success: " + result);
        }
        catch( error )
        {
        	alert("Error: " + error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'bizproc.activity.add',
                    [
                        'CODE'            => 'md5_action',
                        'HANDLER'         => 'https://your_domain/ping.php',
                        'AUTH_USER_ID'    => 1,
                        'USE_SUBSCRIPTION' => 'Y',
                        'NAME'            => [
                            'ru' => 'MD5 генератор',
                            'en' => 'MD5 generator'
                        ],
                        'DESCRIPTION'     => [
                            'ru' => 'Действие возвращает MD5 хеш от входящего параметра',
                            'en' => 'Activity returns MD5 hash of input parameter'
                        ],
                        'PROPERTIES'      => [
                            'inputString' => [
                                'Name'        => [
                                    'ru' => 'Входящая строка',
                                    'en' => 'Input string'
                                ],
                                'Description' => [
                                    'ru' => 'Введите строку, которую вы хотите хешировать',
                                    'en' => 'Input string for hashing'
                                ],
                                'Type'        => 'string',
                                'Required'    => 'Y',
                                'Multiple'    => 'N',
                                'Default'     => '{=Document:NAME}'
                            ]
                        ],
                        'RETURN_PROPERTIES' => [
                            'outputString' => [
                                'Name'     => [
                                    'ru' => 'MD5',
                                    'en' => 'MD5'
                                ],
                                'Type'     => 'string',
                                'Multiple' => 'N',
                                'Default'  => null
                            ]
                        ],
                        'DOCUMENT_TYPE'    => ['lists', 'BizprocDocument', 'iblock_164'],
                        'FILTER'           => [
                            'INCLUDE' => [
                                ['lists']
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'bizproc.activity.add',
            {
                'CODE': 'md5_action',
                'HANDLER': 'https://your_domain/ping.php',
                'AUTH_USER_ID': 1,
                'USE_SUBSCRIPTION': 'Y',
                'NAME': {
                    'ru': 'MD5 генератор',
                    'en': 'MD5 generator'
                },
                'DESCRIPTION': {
                    'ru': 'Действие возвращает MD5 хеш от входящего параметра',
                    'en': 'Activity returns MD5 hash of input parameter'
                },
                'PROPERTIES': {
                    'inputString': {
                        'Name': {
                            'ru': 'Входящая строка',
                            'en': 'Input string'
                        },
                        'Description': {
                            'ru': 'Введите строку, которую вы хотите хешировать',
                            'en': 'Input string for hashing'
                        },
                        'Type': 'string',
                        'Required': 'Y',
                        'Multiple': 'N',
                        'Default': '{=Document:NAME}'
                    }
                },
                'RETURN_PROPERTIES': {
                    'outputString': {
                        'Name': {
                            'ru': 'MD5',
                            'en': 'MD5'
                        },
                        'Type': 'string',
                        'Multiple': 'N',
                        'Default': null
                    }
                },
                'DOCUMENT_TYPE': ['lists', 'BizprocDocument', 'iblock_164'],
                'FILTER': {
                    INCLUDE: [
                        ['lists']
                    ]
                }
            },
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    alert("Success: " + result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.activity.add',
            [
                'CODE' => 'md5_action',
                'HANDLER' => 'https://your_domain/ping.php',
                'AUTH_USER_ID' => 1,
                'USE_SUBSCRIPTION' => 'Y',
                'NAME' => [
                    'ru' => 'MD5 генератор',
                    'en' => 'MD5 generator'
                ],
                'DESCRIPTION' => [
                    'ru' => 'Действие возвращает MD5 хеш от входящего параметра',
                    'en' => 'Activity returns MD5 hash of input parameter'
                ],
                'PROPERTIES' => [
                    'inputString' => [
                        'Name' => [
                            'ru' => 'Входящая строка',
                            'en' => 'Input string'
                        ],
                        'Description' => [
                            'ru' => 'Введите строку, которую вы хотите хешировать',
                            'en' => 'Input string for hashing'
                        ],
                        'Type' => 'string',
                        'Required' => 'Y',
                        'Multiple' => 'N',
                        'Default' => '{=Document:NAME}'
                    ]
                ],
                'RETURN_PROPERTIES' => [
                    'outputString' => [
                        'Name' => [
                            'ru' => 'MD5',
                            'en' => 'MD5'
                        ],
                        'Type' => 'string',
                        'Multiple' => 'N',
                        'Default' => null
                    ]
                ],
                'DOCUMENT_TYPE' => ['lists', 'BizprocDocument', 'iblock_164'],
                'FILTER' => [
                    'INCLUDE' => [
                        ['lists']
                    ]
                ]
            ]
        );
        
        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
            }
        }

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

Название
тип

Описание

result
boolean

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

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

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

Описание

ACCESS_DENIED

Application context required

Необходим контекст приложения

ACCESS_DENIED

Access denied!

Метод выполнил не администратор

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty data!

Не указаны поля с информацией

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty activity code!

Не указан код действия

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong activity code!

Некорректный код действия

ERROR_UNSUPPORTED_PROTOCOL

Unsupported handler protocol

Некорректный протокол хендлера http, https

ERROR_WRONG_HANDLER_URL

Wrong handler URL

Невалидный урл хендлера

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty activity NAME!

Не указано название действия

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong properties array!

Некорректно заполнены параметры PROPERTIES или RETURN_PROPERTIES

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong property key <ключ>!

Некорректный идентификатор свойства

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty property NAME <ключ>!

Не указано название свойства

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong activity FILTER!

Некорректный фильтр

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong activity DOCUMENT_TYPE!

Некорректный DOCUMENT_TYPE

ERROR_ACTIVITY_ALREADY_INSTALLED

Activity or Robot already installed!

Действие с таким кодом уже установлено

ERROR_ACTIVITY_ADD_FAILURE

Activity or Robot already added!

Действие уже было добавлено

ERROR_ACTIVITY_ADD_FAILURE

Activity save error!

Не удалось сохранить действие, системная ошибка

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

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

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

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

Предыдущая
Обзор методов
Следующая
Обновить действие