Вкладка в карточке звонка CALL_CARD

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

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

Scope: placement, telephony

Виджет добавляет свою вкладку в карточку звонка. Обработчик вызывается во время разговора и получает контекст звонка: идентификатор звонка, номер телефона, направление и состояние вызова, связанные элементы CRM.

Код точки встраивания указывается в параметре PLACEMENT метода placement.bind.

Виджет не отображается в интерфейсе, пока установка приложения не завершена. Проверьте установку приложения

Куда встраивается виджет

Код точки встраивания

Место

CALL_CARD

Вкладка в карточке звонка

Где находится в интерфейсе

Карточка звонка появляется у сотрудника, когда начинается разговор. Вкладка приложения выводится в правой части карточки, в одном ряду со встроенными вкладками.

Название вкладки задается параметром метода placement.bind при регистрации.

Параметр
тип

Описание

TITLE
string

Название вкладки в карточке звонка. Если параметр не передан, вместо него выводится название приложения

Название переводится на язык пользователя через параметр LANG_ALL — как в примерах ниже.

Вкладка в карточке звонка

Чтобы проверить виджет, нужен звонок. Внешнюю телефонию поднимают методом telephony.externalCall.register с параметром SHOW = 1 или методом telephony.externalCall.show для уже зарегистрированного звонка.

Список вкладок карточки собирается при загрузке страницы Битрикс24. Если вы зарегистрировали виджет, когда страница уже была открыта, перезагрузите ее — иначе новой вкладки в карточке не будет.

Что получает обработчик

Данные передаются POST-запросом: часть параметров — в query-строке адреса обработчика, остальные — в теле запроса

Array
(
    [DOMAIN] => xxx.bitrix24.com
    [PROTOCOL] => 1
    [LANG] => ru
    [APP_SID] => 588b8a98e848778a4ffb38fbcf70f2b9
    [AUTH_ID] => 4172bb6600705a0700005a4b00000001f0f107c42ca5bd5f61030c5d9c3e4d60d11b5a
    [AUTH_EXPIRES] => 3600
    [REFRESH_ID] => 31f1e26600705a0700005a4b00000001f0f107b1918506d8a2ed9ecf76e8fdac962471
    [SERVER_ENDPOINT] => https://oauth.bitrix24.tech/rest/
    [APPLICATION_TOKEN] => 5b2f8c1d7e3a9046b8c5d2f1a7e3b904
    [APPLICATION_SCOPE] => telephony,crm,placement
    [member_id] => da45a03b265edd8787f8a258d793cc5d
    [status] => L
    [PLACEMENT] => CALL_CARD
    [PLACEMENT_OPTIONS] => {"CALL_ID":"externalCall.c3ee67f1a63f6e6117c230ab59cc49ea.1723556778","PHONE_NUMBER":"+79001234567","LINE_NUMBER":"+7 495 000-00-00","LINE_NAME":"+7 495 000-00-00","CRM_ENTITY_TYPE":"COMPANY","CRM_ENTITY_ID":"17","CRM_ACTIVITY_ID":"undefined","CRM_BINDINGS":[{"ENTITY_TYPE":"DEAL","ENTITY_ID":"25"},{"ENTITY_TYPE":"COMPANY","ENTITY_ID":"17"}],"CALL_DIRECTION":"incoming","CALL_STATE":"connected","CALL_LIST_MODE":"false","URI":"\/crm\/company\/details\/17\/"}
)

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

Параметры в query-строке адреса обработчика

Параметр
тип

Описание

DOMAIN*
string

Адрес Битрикс24, на котором был вызван обработчик виджета

PROTOCOL*
string

Защищенный или незащищенный протокол HTTP:

  • 0 — HTTP
  • 1 — HTTPS

LANG*
string

Язык интерфейса пользователя Битрикс24, который вызвал виджет. Вы можете локализовать язык интерфейса в своем виджете, ориентируясь на это значение

APP_SID*
string

Идентификатор сессии приложения. Битрикс24 создает его заново при каждой отрисовке виджета и использует, чтобы связать js-библиотеку с окружением приложения

Параметры в теле POST-запроса

Параметр
тип

Описание

AUTH_ID
string

Авторизационный токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для вызовов REST API от лица этого пользователя

AUTH_EXPIRES
integer

Время в секундах, после которого авторизационный токен станет неактуальным

REFRESH_ID
string

Refresh-токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для обновления авторизационного токена от лица этого пользователя

SERVER_ENDPOINT*
string

Адрес сервера авторизации Битрикс24, необходимый для обновления токенов OAuth 2

APPLICATION_TOKEN*
string

Токен приложения. То же значение приходит в параметре application_token при вызове обработчиков событий. По нему обработчик виджета может проверить, что запрос пришел от Битрикс24

APPLICATION_SCOPE*
string

Список скоупов, выданных приложению, через запятую. Показывает, какие методы REST API доступны с полученным авторизационным токеном

member_id*
string

Уникальный строковый идентификатор Битрикс24, на котором был вызван обработчик виджета

status
string

Тип приложения, зарегистрировавшего обработчик данного виджета. Принимает значения:

PLACEMENT*
string

Код точки встраивания. Вы можете использовать один и тот же URL обработчика для всех своих виджетов. Значение, которое Битрикс24 будет сообщать в параметре PLACEMENT, поможет определить, из какой именно точки встраивания был вызван ваш обработчик в каждом конкретном случае

PLACEMENT_OPTIONS
string

Дополнительные данные в виде JSON-строки, определяющие контекст выполнения виджета. Например, это может быть массив, содержащий числовой идентификатор элемента CRM, в карточке которого был вызван обработчик виджета, и так далее. Параметр PLACEMENT_OPTIONS вместе с параметром PLACEMENT позволяет точно определить, для какой именно точки встраивания и какого объекта был вызван обработчик виджета

Битрикс24 добавляет в PLACEMENT_OPTIONS ключ URI — путь с query-строкой той страницы, с которой открыт виджет. Он приходит для любой точки встраивания, вместе с ее собственными ключами. Ключа не будет, если браузер не передал заголовок Referer или виджет открыт со страницы другого домена.

Как разобрать контекст вызова

PLACEMENT_OPTIONS приходит JSON-строкой, а не массивом: перед использованием разберите ее на стороне обработчика. Состав ключей у каждой точки свой и описан в разделе PLACEMENT_OPTIONS этой страницы.

$placement = $_POST['PLACEMENT'] ?? '';
$options = json_decode($_POST['PLACEMENT_OPTIONS'] ?? '{}', true);

options = json.loads(request.form.get("PLACEMENT_OPTIONS", "{}") or "{}")

В B24JsSDK разбирать строку не нужно: свойство $b24.placement.options возвращает готовый объект, а $b24.placement.placement — код точки встраивания.

Что должен вернуть обработчик

Обработчик отвечает обычной HTML-страницей — Битрикс24 показывает ее во фрейме на месте виджета. Страница должна разрешать встраивание: если сервер приложения отдает заголовки X-Frame-Options или Content-Security-Policy, запрещающие фрейм, на месте виджета останется пустая область. Как это исправить, описано в статье Сайт не разрешает подключение.

PLACEMENT_OPTIONS

Значение PLACEMENT_OPTIONS передается как JSON-строка с контекстом звонка.

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

Параметр

Описание

CALL_ID*
string

Идентификатор звонка, во время которого открыт виджет.

Этот же идентификатор возвращает метод telephony.externalCall.register. Его принимают методы завершения звонка и прикрепления записи разговора

PHONE_NUMBER
string

Номер телефона клиента, с которым идет разговор.

Номер приходит в нормализованном виде, без пробелов и разделителей. Если номер клиента неизвестен, ключ не передается

LINE_NUMBER
string

Номер телефона компании, на который поступил звонок или с которого он совершается

LINE_NAME
string

Название телефонной линии компании.

Линии добавляются приложениями для интеграции телефоний методом telephony.externalLine.add и используются в сквозной аналитике. Если у линии нет названия, в ключе приходит ее номер

CRM_ENTITY_TYPE
string

Символьный код типа элемента CRM, к которому привязан звонок: LEAD, DEAL, CONTACT, COMPANY.

Это entityTypeName, а не числовой идентификатор типа. Если звонок не привязан к CRM, ключ приходит пустым

CRM_ENTITY_ID
string

Идентификатор элемента CRM, к которому привязан звонок.

Зная тип и идентификатор, можно получить данные элемента:

Если звонок не привязан к CRM, в ключе приходит 0

CRM_BINDINGS
array

Все элементы CRM, связанные со звонком. Состав элемента массива описан ниже.

Ключи CRM_ENTITY_TYPE и CRM_ENTITY_ID называют только основной элемент. Если звонок связан сразу с несколькими элементами — например, с компанией и ее сделкой, — полный список приходит в CRM_BINDINGS.

Если связанных элементов нет, ключ не передается

CRM_ACTIVITY_ID
string

Идентификатор дела CRM, созданного для этого звонка.

Данные дела возвращает метод crm.activity.get.

Если дело для звонка не создано, в ключе приходит строка undefined. Проверяйте значение перед использованием

CALL_DIRECTION*
string

Направление звонка. Возможные значения:

  • incoming — входящий звонок
  • outgoing — исходящий звонок
  • callback — обратный звонок

CALL_STATE
string

Состояние звонка в момент открытия виджета. Возможные значения:

  • idle — разговор еще не начат
  • connecting — идет соединение
  • connected — активный разговор

CALL_LIST_MODE
string

Указывает, совершается ли звонок в рамках обзвона. Значение приходит строкой: true или false

Вместе с этими ключами приходит универсальный ключ URI — он описан выше, в стандартных данных.

Состав CRM_BINDINGS

Ключ
тип

Описание

ENTITY_TYPE
string

Символьный код типа элемента CRM: LEAD, DEAL, CONTACT, COMPANY

ENTITY_ID
string

Идентификатор элемента CRM

Точка не поддерживает параметр OPTIONS метода placement.bind: переданные значения не сохраняются, placement.get возвращает пустой массив.

Управление карточкой звонка из обработчика

Обработчик может не только читать контекст, но и работать с карточкой звонка из браузера: получить данные текущего звонка, запретить и снова разрешить автоматическое закрытие карточки, отследить смену клиента и состояния звонка. Команды и события карточки описаны в разделе Карточка звонка CALL_CARD: обзор команд и событий.

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "PLACEMENT": "CALL_CARD",
    "HANDLER": "https://your-domain.com/widgets/call-card-handler.php",
    "TITLE": "Карточка клиента",
    "LANG_ALL": {
      "ru": {
        "TITLE": "Карточка клиента"
      },
      "en": {
        "TITLE": "Customer profile"
      }
    },
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/placement.bind

// 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: 'CALL_CARD',
      HANDLER: 'https://your-domain.com/widgets/call-card-handler.php',
      TITLE: 'Customer profile',
      LANG_ALL: {
        ru: {
          TITLE: 'Карточка клиента',
        },
        en: {
          TITLE: 'Customer profile',
        },
      },
    },
    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 bound successfully:', 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 bindCallCard() {
    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: 'CALL_CARD',
          HANDLER: 'https://your-domain.com/widgets/call-card-handler.php',
          TITLE: 'Customer profile',
          LANG_ALL: {
            ru: {
              TITLE: 'Карточка клиента',
            },
            en: {
              TITLE: 'Customer profile',
            },
          },
        },
        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 bound successfully:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try {
    $response = $b24Service
        ->core
        ->call(
            'placement.bind',
            [
                'PLACEMENT' => 'CALL_CARD',
                'HANDLER' => 'https://your-domain.com/widgets/call-card-handler.php',
                'TITLE' => 'Карточка клиента',
                'LANG_ALL' => [
                    'ru' => [
                        'TITLE' => 'Карточка клиента',
                    ],
                    'en' => [
                        'TITLE' => 'Customer profile',
                    ],
                ],
            ]
        );

    $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.callMethod(
    'placement.bind',
    {
        PLACEMENT: 'CALL_CARD',
        HANDLER: 'https://your-domain.com/widgets/call-card-handler.php',
        TITLE: 'Карточка клиента',
        LANG_ALL: {
            ru: { TITLE: 'Карточка клиента' },
            en: { TITLE: 'Customer profile' }
        }
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'placement.bind',
    [
        'PLACEMENT' => 'CALL_CARD',
        'HANDLER' => 'https://your-domain.com/widgets/call-card-handler.php',
        'TITLE' => 'Карточка клиента',
        'LANG_ALL' => [
            'ru' => [
                'TITLE' => 'Карточка клиента',
            ],
            'en' => [
                'TITLE' => 'Customer profile',
            ],
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
	"PLACEMENT": "CALL_CARD",
	"HANDLER":   "https://your-domain.com/widgets/call-card-handler.php",
	"TITLE":     "Карточка клиента",
	"LANG_ALL": b24.Params{
		"ru": b24.Params{
			"TITLE": "Карточка клиента",
		},
		"en": b24.Params{
			"TITLE": "Customer profile",
		},
	},
})
if err != nil {
	return fmt.Errorf("placement.bind: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его в структуру
// под форму ответа из раздела «Обработка ответа» страницы placement.bind.
fmt.Printf("%s\n", res.Result)

Типовые ошибки

Ошибка

Как решить

placement.bind возвращает WRONG_AUTH_TYPE с описанием Application context required

Регистрируйте точку от имени приложения. Вебхуком точку не привязать

placement.bind возвращает ERROR_PLACEMENT_NOT_FOUND

Код точки указан неверно или приложению не выдан скоуп telephony

placement.bind возвращает ERROR_ARGUMENT

Передайте обязательные параметры PLACEMENT и HANDLER. Код незаполненного поля приходит в argument

Виджет зарегистрирован, но вкладки в карточке звонка нет

Завершите установку приложения и перезагрузите страницу Битрикс24: список вкладок карточки собирается при загрузке страницы

Обработчик не находит идентификатор дела

Если дело для звонка не создано, в CRM_ACTIVITY_ID приходит строка undefined. Проверяйте значение перед использованием

Обработчик не распознает CRM_ENTITY_TYPE

В ключе приходит символьный код типа — LEAD, DEAL, CONTACT, COMPANY, — а не числовой идентификатор

Виджет не видит второй связанный элемент CRM

Ключи CRM_ENTITY_TYPE и CRM_ENTITY_ID называют только основной элемент. Полный список связей приходит в CRM_BINDINGS

Ошибка приходит в теле ответа — код в поле error, текст в error_description:

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

Другие коды ошибок регистрации перечислены в разделе «Возможные коды ошибок» страницы placement.bind.

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

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