Закрыть карточку звонка со стороны приложения CallCardClose

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

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

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

Кто может выполнять команду: любой пользователь

Команда CallCardClose закрывает карточку звонка.

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

Как вызвать команду

Команду вызывают из виджета методом BX24.placement.call. Третий аргумент — функция обратного вызова, в нее приходит результат команды.

BX24.placement.call('CallCardClose', {}, function (result) {
    console.log(result);
});

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

Команда не принимает параметров. Вторым аргументом передайте пустой объект {}.

Важно

После вызова CallCardClose дальнейшее управление карточкой невозможно.

Примеры кода

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

Рекомендуется вызывать команду после события BackgroundCallCard::initialized

BX24.ready(function () {
    BX24.init(function () {
        BX24.placement.call('CallCardClose', {}, function (result) {
            console.log(result);
        });
    });
});

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

declare const $b24: B24Frame

await $b24.placement.call('CallCardClose')

<!-- Загрузка 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()

    const result = await $b24.placement.call('CallCardClose')

    console.log(result)
  })
</script>

Результат команды

[]

Возвращаемые данные

Пустой массив при успешном вызове.

Ошибки

Ошибка команды приходит в ту же функцию обратного вызова: вместо обычного результата в нее передается массив с объектом, у которого result равен error.

[
    {
        "result": "error",
        "errorCode": "Call card is undefined"
    }
]

Значения errorCode

Код

Описание

Значение

Call card is undefined

Карточка звонка недоступна

Нет активной карточки звонка для закрытия

Если команда вызвана в другой точке встраивания, функция обратного вызова не будет вызвана вовсе: неизвестную команду интерфейс точки встраивания игнорирует. Проверить, что команда CallCardClose доступна, можно методом BX24.placement.getInterface.

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

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