Put the Call on Hold from the Application CallCardSetHold

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

Who can execute the command: any user

The CallCardSetHold command puts the call on hold or takes it off hold in the call card.

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('CallCardSetHold', {held: true}, function (result) {
            console.log(result);
        });
        

Command ParametersCommand Parameters

Required parameters are marked with *

Code ExamplesCode Examples

How to Use Examples in Documentation

BX24.ready(function () {
            BX24.init(function () {
                BX24.placement.call('CallCardSetHold', {held: true}, 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('CallCardSetHold', { held: true })
        

<!-- 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('CallCardSetHold', {held: true})
        
            console.log(result)
          })
        </script>
        

Command ResultCommand Result

[]
        

Returned DataReturned Data

An empty array on a successful call.

If the call is already in the requested state, the command returns an empty array right away: the card does not change and the BackgroundCallCard::holdButtonClick event does not occur.

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

Continue LearningContinue Learning

• Mute the Operator's Microphone from the Application CallCardSetMute
• Change the Call Card Interface State from the Application CallCardSetUiState
• Get the List of Available Call Card Interface States CallCardGetListUiStates
• Change the Call Card Title from the Application CallCardSetCardTitle
• Change the Text in the Center of the Call Card from the Application CallCardSetStatusText
• Close the Call Card from the Application CallCardClose
• 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