# placement.bind

URL: https://chugunov.pro/api-bitrix24/widgets/placement-bind/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Зарегистрировать обработчик виджета
Scope: `placement, в зависимости от точки встраивания`
Кто может выполнять метод: администратор

## Описание

Метод `placement.bind` регистрирует обработчик виджета в точке встраивания.

Он может быть вызван в любой момент во время работы приложения, однако чаще всего, удобнее регистрировать свои виджеты во время [установки приложения](https://apidocs.bitrix24.ru/settings/app-installation/index.html).

Пока установка приложения не завершена, зарегистрированные виджеты не отображаются в интерфейсе Битрикс24 — ни обычным пользователям, ни администраторам.
[Проверьте установку приложения](https://apidocs.bitrix24.ru/settings/app-installation/installation-finish.html).

## Параметры

- `PLACEMENT` `string` — обязательный. Код точки встраивания
- `HANDLER` `string` — обязательный. URL обработчика виджета
- `TITLE` `string` — необязательный. Название виджета в интерфейсе. В зависимости от точки встраивания это может быть название вкладки в форме, название пункта меню и т.д.
- `DESCRIPTION` `string` — необязательный. Описание виджета в интерфейсе. На практике не используется
- `GROUP_NAME` `string` — необязательный. Позволяет объединять элементы пользовательского интерфейса для нескольких обработчиков одного и того же типа виджета в группу. Например, несколько пунктов выпадающего меню в [верхней кнопке карточки CRM](https://apidocs.bitrix24.ru/api-reference/widgets/crm/detail-toolbar.html). Поддерживается только некоторыми типами виджетов
- `LANG_ALL` `object` — необязательный. Массив параметров `TITLE`, `DESCRIPTION` и `GROUP_NAME` для указанных языков. Пользователи, у которых в интерфейсе Битрикс24 выбран один из таких языков, будут видеть локализованные версии `TITLE`, `DESCRIPTION` и `GROUP_NAME`: 
  ```json
      "LANG_ALL": {
          "en": {
              "TITLE": "title",
              "DESCRIPTION": "description",
              "GROUP_NAME": "group"
          },
          "ru": {
              "TITLE": "заголовок",
              "DESCRIPTION": "описание",
              "GROUP_NAME": "группа"
          }
      }
  ```
- `OPTIONS` `object` — необязательный. Дополнительные параметры отображения виджета. Конкретные значения зависят от точки встраивания. На текущий момент используется в виджетах для мессенджера, в виджете [`PAGE_BACKGROUND_WORKER`](https://apidocs.bitrix24.ru/api-reference/widgets/universal/background-worker.html) и в виджете [CRM_XXX_DETAIL_ACTIVITY](https://apidocs.bitrix24.ru/api-reference/widgets/crm/detail-activity-area.html)
- `USER_ID` `integer` — необязательный. Идентификатор пользователя Битрикс24, для которого будет доступен зарегистрированный виджет. Возможные значение можно получить с помощью метода [user.get](https://chugunov.pro/api-bitrix24/user/user-get/)
  На текущий момент этот параметр поддерживается только виджетом [`PAGE_BACKGROUND_WORKER`](https://apidocs.bitrix24.ru/api-reference/widgets/universal/background-worker.html).
  При попытке зарегистрировать этот параметр в других точках встраивания вы получите ошибку `ERROR_PLACEMENT_USER_MODE: User mode is not available`.

## Ответ

HTTP-статус: 200

```json
{
    "result": true,
    "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`. Возвращает результат добавления обработчика виджета. Возможные значения:
  - `True`, обработчик успешно зарегистрирован;
  - `False`, обработчик не зарегистрирован
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "ERROR_ARGUMENT",
    "error_description": "Argument 'PLACEMENT' is null or empty",
    "argument": "PLACEMENT"
}
```

- `ERROR_PLACEMENT_MAX_COUNT` — Произошла попытка повторной регистрации обработчика виджета, который допускает только одну регистрацию: `PAGE_BACKGROUND_WORKER` или [`REST_APP_URI`](https://apidocs.bitrix24.ru/api-reference/widgets/universal/app-url.html). 200
- `ERROR_PLACEMENT_USER_MODE` — Параметр `USER_ID` передан для виджета, который не поддерживает регистрацию для отдельного пользователя. 200
- `EMPTY_ERROR_HANDLER_URL` — При регистрации виджета `PAGE_BACKGROUND_WORKER` не передан обязательный параметр `OPTIONS[errorHandlerUrl]`. 200
- `ERROR_ARGUMENT` — Не указано значение обязательного поля. Код обязательного поля возвращается в `argument`. 200
- `WRONG_AUTH_TYPE` — Current authorization type is denied for this method Application context required. 403

## Примеры запроса

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"PLACEMENT":"PLACEMENT_CODE","HANDLER":"http://myapp.com/handler/?type=1","OPTIONS":{"errorHandlerUrl":"http://myapp.com/error/"},"TITLE":"title","DESCRIPTION":"description","GROUP_NAME":"group","LANG_ALL":{"en":{"TITLE":"title","DESCRIPTION":"description","GROUP_NAME":"group"},"ru":{"TITLE":"заголовок","DESCRIPTION":"описание","GROUP_NAME":"группа"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/placement.bind
```

### JS (TS)

```ts
// 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

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'placement.bind',
    params: {
      PLACEMENT: 'PLACEMENT_CODE',
      HANDLER: 'http://myapp.com/handler/?type=1',
      OPTIONS: {
        errorHandlerUrl: 'http://myapp.com/error/',
      },
      TITLE: 'title',
      DESCRIPTION: 'description',
      GROUP_NAME: 'group',
      LANG_ALL: {
        en: {
          TITLE: 'title',
          DESCRIPTION: 'description',
          GROUP_NAME: 'group',
        },
        ru: {
          TITLE: 'заголовок',
          DESCRIPTION: 'описание',
          GROUP_NAME: 'группа',
        },
      },
    },
    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('Handler registered:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 bindPlacement() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'placement.bind',
        params: {
          PLACEMENT: 'PLACEMENT_CODE',
          HANDLER: 'http://myapp.com/handler/?type=1',
          OPTIONS: {
            errorHandlerUrl: 'http://myapp.com/error/',
          },
          TITLE: 'title',
          DESCRIPTION: 'description',
          GROUP_NAME: 'group',
          LANG_ALL: {
            en: {
              TITLE: 'title',
              DESCRIPTION: 'description',
              GROUP_NAME: 'group',
            },
            ru: {
              TITLE: 'заголовок',
              DESCRIPTION: 'описание',
              GROUP_NAME: 'группа',
            },
          },
        },
        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('Handler registered:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', bindPlacement)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.placement.bind(
        placement="PLACEMENT_CODE",
        handler="http://myapp.com/handler/?type=1",
        options={
            "errorHandlerUrl": "http://myapp.com/error/",
        },
        title="title",
        description="description",
        group_name="group",
        lang_all={
            "en": {
                "TITLE": "title",
                "DESCRIPTION": "description",
                "GROUP_NAME": "group",
            },
            "ru": {
                "TITLE": "заголовок",
                "DESCRIPTION": "описание",
                "GROUP_NAME": "группа",
            },
        },
    ).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}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'placement.bind',
            [
                'PLACEMENT' => 'PLACEMENT_CODE',
                'HANDLER' => 'http://myapp.com/handler/?type=1',
                'OPTIONS' => [
                    'errorHandlerUrl' => 'http://myapp.com/error/'
                ],
                'TITLE' => 'title',
                'DESCRIPTION' => 'description',
                'GROUP_NAME' => 'group',
                'LANG_ALL' => [
                    'en' => [
                        'TITLE' => 'title',
                        'DESCRIPTION' => 'description',
                        'GROUP_NAME' => 'group',
                    ],
                    'ru' => [
                        'TITLE' => 'заголовок',
                        'DESCRIPTION' => 'описание',
                        'GROUP_NAME' => 'группа',
                    ]
                ]
            ]
        );

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

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

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error binding placement: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    "placement.bind",
    { 
        "PLACEMENT": "PLACEMENT_CODE",
        "HANDLER": "http://myapp.com/handler/?type=1",
        "OPTIONS": {
            "errorHandlerUrl": "http://myapp.com/error/"
        },
        "TITLE": "title",
        "DESCRIPTION": "description",
        "GROUP_NAME": "group",
        "LANG_ALL": {
            "en": {
                "TITLE": "title",
                "DESCRIPTION": "description",
                "GROUP_NAME": "group",
            },
            "ru": {
                "TITLE": "заголовок",
                "DESCRIPTION": "описание",
                "GROUP_NAME": "группа",
            }
        }
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.info(result.data());
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'placement.bind',
    [
        'PLACEMENT' => 'PLACEMENT_CODE',
        'HANDLER' => 'http://myapp.com/handler/?type=1',
        'OPTIONS' => [
            'errorHandlerUrl' => 'http://myapp.com/error/'
        ],
        'TITLE' => 'title',
        'DESCRIPTION' => 'description',
        'GROUP_NAME' => 'group',
        'LANG_ALL' => [
            'en' => [
                'TITLE' => 'title',
                'DESCRIPTION' => 'description',
                'GROUP_NAME' => 'group'
            ],
            'ru' => [
                'TITLE' => 'заголовок',
                'DESCRIPTION' => 'описание',
                'GROUP_NAME' => 'группа'
            ]
        ]
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
	"PLACEMENT": "PLACEMENT_CODE",
	"HANDLER":   "http://myapp.com/handler/?type=1",
	"OPTIONS": b24.Params{
		"errorHandlerUrl": "http://myapp.com/error/",
	},
	"TITLE":       "title",
	"DESCRIPTION": "description",
	"GROUP_NAME":  "group",
	"LANG_ALL": b24.Params{
		"en": b24.Params{
			"TITLE":       "title",
			"DESCRIPTION": "description",
			"GROUP_NAME":  "group",
		},
		"ru": b24.Params{
			"TITLE":       "заголовок",
			"DESCRIPTION": "описание",
			"GROUP_NAME":  "группа",
		},
	},
})
if err != nil {
	return fmt.Errorf("placement.bind: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/widgets/placement-bind.html