Change the Text in the Center of the Call Card from the Application CallCardSetStatusText

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: placement — registration of the placement, telephony — registration of the call that raises the card

Who can execute the command: any user

The CallCardSetStatusText command changes the status text in the center of the call card.

The command operates within the application context in the PAGE_BACKGROUND_WORKER placement. This is a JS interface command, not a REST method: it cannot be invoked with a request to /rest/.

How to Call the Command

The command is invoked from the widget with the BX24.placement.call method. The third argument is the callback function, which receives the result of the command.

BX24.placement.call('CallCardSetStatusText', {statusText: 'Connection established'}, function (result) {
    console.log(result);
});

Command Parameters

Required parameters are marked with *

Name
type

Description

statusText*
string

The new status text in the center of the card

Code Examples

How to Use Examples in Documentation

It is recommended to call the command after the BackgroundCallCard::initialized event

BX24.ready(function () {
    BX24.init(function () {
        BX24.placement.call('CallCardSetStatusText', {statusText: 'Connection established'}, function (result) {
            console.log(result);
        });
    });
});

// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide)
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

await $b24.placement.call('CallCardSetStatusText', { statusText: 'Connection established' })

<!-- 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>
  document.addEventListener('DOMContentLoaded', async () => {
    const $b24 = await B24Js.initializeB24Frame()

    const result = await $b24.placement.call('CallCardSetStatusText', {statusText: 'Connection established'})

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

Command Result

[]

Returned Data

An empty array on a successful call.

Errors

The command error arrives in the same callback function: instead of the usual result, it receives an array with an object whose result equals error.

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

errorCode Values

Code

Description

Value

Call card is undefined

The call card is unavailable

There is no active call card to manage

missing field statusText

The required statusText parameter was not passed

In the desktop scenario, the statusText field is required

If the command is invoked in another placement, the callback function will not be invoked at all: the placement interface ignores an unknown command. To check that the CallCardSetStatusText command is available, use the BX24.placement.getInterface method.

Continue Learning

Previous
Change Call Card Title from the Application
Next
Start the Call Timer from the Application