Получить список зарегистрированных обработчиков мест встраивания placement.get

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: placement, в зависимости от места встройки

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

Метод placement.get получает список зарегистрированных обработчиков мест встраивания виджетов.

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

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

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/placement.get
        
try
        {
        	const response = await $b24.callMethod(
        		"placement.get",
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.get',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Info: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting placements: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "placement.get",
            {},
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.info(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'placement.get',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": [
                {
                    "placement": "CRM_DEAL_LIST_TOOLBAR",
                    "userId": 0,
                    "handler": "https://myapp.com/?handler=1",
                    "options": [],
                    "title": "Add invoice",
                    "description": "",
                    "langAll": {
                        "ru": {
                            "TITLE": "Add invoice",
                            "DESCRIPTION": "",
                            "GROUP_NAME": "Documents"
                        }
                    }
                },
                {
                    "placement": "CRM_DEAL_LIST_TOOLBAR",
                    "userId": 0,
                    "handler": "https://myapp.com/?handler=1",
                    "options": [],
                    "title": "Import invoice",
                    "description": "",
                    "langAll": {
                        "ru": {
                            "TITLE": "Import invoice",
                            "DESCRIPTION": "",
                            "GROUP_NAME": "Documents"
                        }
                    }
                },
                {
                    "placement": "IM_CONTEXT_MENU",
                    "userId": 0,
                    "handler": "https://myapp.com/?handler=2",
                    "options": {
                        "extranet": "N",
                        "context": "ALL",
                        "role": "USER"
                    },
                    "title": "My App 1",
                    "description": "",
                    "langAll": {
                        "ru": {
                            "TITLE": "My App 1",
                            "DESCRIPTION": "",
                            "GROUP_NAME": ""
                        }
                    }
                },
                {
                    "placement": "PAGE_BACKGROUND_WORKER",
                    "userId": 1,
                    "handler": "https://myapp.com/?handler=3",
                    "options": {
                        "errorHandlerUrl": "https://myapp.com/?handler=3"
                    },
                    "title": "My App 2",
                    "description": "",
                    "langAll": {
                        "ru": {
                            "TITLE": "My App 2",
                            "DESCRIPTION": "",
                            "GROUP_NAME": ""
                        }
                    }
                },
            ],
            "time": {
                "start": 1712132792.910734,
                "finish": 1712132793.530359,
                "duration": 0.6196250915527344,
                "processing": 0.032338857650756836,
                "date_start": "2024-04-03T10:26:32+02:00",
                "date_finish": "2024-04-03T10:26:33+02:00",
                "operating_reset_at": 1705765533,
                "operating": 3.3076241016387939
            }
        }

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

Название
тип

Описание

result
boolean

Возвращает список зарегистрированных обработчиков виджетов. Структура каждого элемента соответствует параметрам метода регистрации обработчика

time
time

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

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

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

{
            "error": "INVALID_REQUEST",
            "error_description": "Https required",
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Статус

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

403

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

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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

Предыдущая
Зарегистрировать виджет
Следующая
Получить список виджетов