Stop the Call Timer from the Application CallCardStopTimer

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

Who can execute the command: any user

The CallCardStopTimer command stops counting the conversation time in the call card.

The command is needed when the application shows its own conversation time in the card or puts the call on hold.

Some interface states stop the timer on their own: incoming, transferIncoming, outgoing, connectingIncoming, connectingOutgoing, error, moneyError, and redial. During a call transfer, however — the transferring, transferFailed, and transferConnected states — the countdown continues, and only this command can stop it. The states are described on the page CallCardSetUiState.

How to Call the CommandHow 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('CallCardStopTimer', {}, function (result) {
            // in the browser, the callback function is not invoked on success
            console.log(result);
        });
        

Command ParametersCommand Parameters

The command takes no parameters. Pass an empty object {} as the second argument.

Code ExamplesCode Examples

How to Use Examples in Documentation

BX24.ready(function () {
            BX24.init(function () {
                BX24.placement.call('CallCardStopTimer', {}, 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
        
        // in the browser, the promise does not resolve on success — do not await the result
        $b24.placement.call('CallCardStopTimer')
        

<!-- 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()
        
            // in the browser, the promise does not resolve on success — do not await the result
            $b24.placement.call('CallCardStopTimer')
          })
        </script>
        

Command ResultCommand Result

In the browser, a successful call returns nothing: the callback function is not invoked, and the counting in the card stops.

The timer itself is not hidden — the last value stays in the card. It disappears when the card switches to a state other than connected. Calling the command again on an already stopped timer is safe: it does nothing and reports nothing.

In the Bitrix24 desktop application, an empty array arrives after a successful call.

[]
        

ErrorsErrors

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 ValueserrorCode Values

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 CallCardStopTimer command is available, use the BX24.placement.getInterface method.

Continue LearningContinue Learning

• Start the Call Timer from the Application CallCardStartTimer
• Change the Call Card Interface State from the Application CallCardSetUiState
• Call Card
• Overview of Events for Working with the Call Card of a WebRTC Client
• Manage the Call Card of a WebRTC Client: Overview of Commands and Events