Получить точки встраивания, доступные приложению placement.list

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

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

Scope: placement

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

Метод placement.list возвращает коды точек встраивания, которые приложение может зарегистрировать методом placement.bind. Обработчики, которые приложение уже зарегистрировало, возвращает метод placement.get.

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

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

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

Название
тип

Описание

SCOPE
string

Код scope, для которого нужно получить точки встраивания, например crm, task или sonet_group. Коды перечислены на странице Доступные скоупы Битрикс24.

Если параметр передан и не пустой, метод возвращает точки встраивания только для указанного scope. Scope не обязательно должен входить в права приложения.

Если параметр передан пустой строкой, метод возвращает только глобальные точки встраивания, которые не относятся ни к одному scope, например LEFT_MENU, REST_APP_URI, IM_SIDEBAR.

Если scope не существует или у него нет точек встраивания, метод возвращает пустой массив без ошибки

FULL
boolean

Флаг получения полного списка точек встраивания.

Если параметр не передан или передан как false, метод возвращает точки встраивания для scope текущего приложения и глобальные точки.

Если параметр передан как true, метод возвращает точки встраивания для всех scope портала.

Параметр учитывается, только если не передан SCOPE

Метод возвращает весь список одним ответом, постраничной выдачи нет: параметр start игнорируется, даже если в списке больше 50 кодов. Состав списка зависит от портала: от установленных модулей и созданных смарт-процессов. Служебные точки, которые нельзя зарегистрировать из приложения, в список не попадают.

Примеры кода

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

Пример получения точек встраивания CRM, где:

  • SCOPE — код scope, для которого нужно получить точки встраивания
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "SCOPE": "crm",
    "auth": "**put_access_token_here**"
  }' \
  "https://**put.your-domain-here**/rest/placement.list.json"
// 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 {
  // placement.list returns the full list of placement codes in one response
  const response = await $b24.actions.v2.call.make<string[]>({
    method: 'placement.list',
    params: {
      SCOPE: 'crm',
    },
    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('Placement codes:', result, 'Count:', result.length)
  }
} 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 getPlacementList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // placement.list returns the full list of placement codes in one response
      const response = await $b24.actions.v2.call.make({
        method: 'placement.list',
        params: {
          SCOPE: 'crm',
        },
        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('Placement codes:', result, 'Count:', result.length)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getPlacementList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.placement.list(
        scope="crm",
    ).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.list',
            [
                'SCOPE' => 'crm',
            ]
        );

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

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting placement list: ' . $e->getMessage();
}
BX24.callMethod(
    'placement.list',
    {
        SCOPE: 'crm'
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);
$result = CRest::call(
    'placement.list',
    [
        'SCOPE' => 'crm',
    ]
);

echo '<pre>';
print_r($result);
echo '</pre>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "placement.list", b24.Params{
	"SCOPE": "crm",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("placement.list: %w", err)
}

var items []string
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("получено:", len(items))

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

HTTP-статус: 200

{
    "result": [
        "CRM_DEAL_LIST_TOOLBAR",
        "CRM_LEAD_LIST_TOOLBAR",
        "CRM_CONTACT_LIST_TOOLBAR",
        "CRM_COMPANY_LIST_TOOLBAR",
        "CRM_INVOICE_LIST_TOOLBAR",
        "CRM_QUOTE_LIST_TOOLBAR",
        "CRM_ORDER_LIST_TOOLBAR",
        "CRM_DYNAMIC_136_LIST_TOOLBAR",
        "CRM_DYNAMIC_1038_LIST_TOOLBAR",
        "CRM_SMART_INVOICE_LIST_TOOLBAR",
        "CRM_DEAL_DETAIL_TOOLBAR",
        "CRM_LEAD_DETAIL_TOOLBAR",
        "CRM_CONTACT_DETAIL_TOOLBAR",
        "CRM_COMPANY_DETAIL_TOOLBAR",
        "CRM_INVOICE_DETAIL_TOOLBAR",
        "CRM_QUOTE_DETAIL_TOOLBAR",
        "CRM_DYNAMIC_136_DETAIL_TOOLBAR",
        "CRM_DYNAMIC_1038_DETAIL_TOOLBAR",
        "CRM_SMART_INVOICE_DETAIL_TOOLBAR",
        "CRM_DEAL_ACTIVITY_TIMELINE_MENU",
        "CRM_LEAD_ACTIVITY_TIMELINE_MENU",
        "CRM_QUOTE_ACTIVITY_TIMELINE_MENU"
    ],
    "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
string[]

Список кодов точек встраивания, доступных приложению.

Каждый элемент массива — код точки встраивания, который можно передать в параметре PLACEMENT метода placement.bind. Коды точек смарт-процессов содержат идентификатор типа смарт-процесса, например CRM_DYNAMIC_136_LIST_TOOLBAR. Описания точек собраны на странице Каталог точек встраивания

time
time

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

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

HTTP-статус: 403

{
    "error": "WRONG_AUTH_TYPE",
    "error_description": "Current authorization type is denied for this method Application context required"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

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

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

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

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

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