При загрузке или смене объекта CRM BackgroundCallCard::entityChanged

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

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

Scope: placement — регистрация точки встраивания, telephony — регистрация звонка, поднимающего карточку

Кто может подписаться: любой пользователь

Событие BackgroundCallCard::entityChanged возникает, когда карточка загружает или меняет связанный со звонком объект CRM.

Событие приходит в трех случаях:

  • карточка звонка открылась и подтянула данные клиента из CRM. В этом случае событие может прийти раньше, чем BackgroundCallCard::initialized
  • клиента опознали или звонок перепривязали к другому объекту CRM
  • в режиме обзвона оператор перешел к следующему клиенту

Событие работает в контексте приложения, открытого в точке встраивания PAGE_BACKGROUND_WORKER. Это событие js-интерфейса, а не событие REST: подписаться на него запросом к /rest/ нельзя.

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

Данные передаются в функцию обратного вызова метода BX24.placement.bindEvent

callback({
    "PHONE_NUMBER": "+79001234567",
    "CRM_ENTITY_TYPE": "CONTACT",
    "CRM_ENTITY_ID": 123
});

Параметры обработчика события

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

Параметр
тип

Описание

PHONE_NUMBER
string

Номер телефона клиента.

Если у клиента нет ни одного телефона, приходит строка unknown

CRM_ENTITY_TYPE
string

Тип связанного со звонком объекта CRM

CRM_ENTITY_ID
integer

Идентификатор связанного со звонком объекта CRM.

0, если звонок не привязан к CRM

Параметры подписки

Обработчик регистрируют из виджета методом BX24.placement.bindEvent.

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

Название
тип

Описание

event*
string

Имя события интерфейса.

Для данного события — BackgroundCallCard::entityChanged

callback*
callable

Функция, которую Битрикс24 вызывает при наступлении события. Аргументы обработчика описаны выше

Примеры кода

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

BX24.ready(function () {
    BX24.init(function () {
        BX24.placement.bindEvent('BackgroundCallCard::entityChanged', function (eventData) {
            console.log(eventData);
        });
    });
});

// $b24 — инициализированный экземпляр SDK, см. руководство по началу работы
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

await $b24.placement.bindEvent('BackgroundCallCard::entityChanged', (eventData: { PHONE_NUMBER: string; CRM_ENTITY_TYPE: string; CRM_ENTITY_ID: number }) => {
  console.log(eventData.CRM_ENTITY_ID)
})

<!-- Загрузка SDK в UMD-сборке, глобальный объект B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  document.addEventListener('DOMContentLoaded', async () => {
    const $b24 = await B24Js.initializeB24Frame()

    await $b24.placement.bindEvent('BackgroundCallCard::entityChanged', (eventData) => {
      console.log(eventData)
    })
  })
</script>

Ошибки

Проверьте условия.

  • Виджет открыт в точке встраивания PAGE_BACKGROUND_WORKER. В других точках встраивания события BackgroundCallCard::* не зарегистрированы, и подписка молча не сработает
  • Имя события передано без опечаток и с учетом регистра. Список событий, доступных в текущей точке встраивания, возвращает BX24.placement.getInterface
  • Звонок поднят приложением методом telephony.externalCall.register. Для звонков самого Битрикс24 события BackgroundCallCard::* не эмитятся вовсе

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

Предыдущая
При нажатии на кнопку «ответить»
Следующая
При нажатии на кнопку «позвонить» или «перезвонить»