метод REST
scope: placement, в зависимости от точки встраивания
placement.get
Получить обработчики, зарегистрированные приложением
Описание
Метод 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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each PlacementHandler returned in result[]
type PlacementHandler = {
placement: string
userId: number
handler: string
options: Record<string, string> | unknown[]
title: string
description: string
langAll: Record<string, { TITLE: string; DESCRIPTION: string; GROUP_NAME: string }>
}
try {
const response = await $b24.actions.v2.call.make<PlacementHandler[]>({
method: 'placement.get',
params: {},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Registered handlers count:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getPlacementHandlers() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'placement.get',
params: {},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Registered handlers count:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getPlacementHandlers)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.placement.get().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(
'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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "placement.get", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("placement.get: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
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
{
"error": "INVALID_REQUEST",
"error_description": "Https required"
}
| Код | Описание | Значение |
|---|---|---|
WRONG_AUTH_TYPE |
Current authorization type is denied for this method Application context required | 403 |

