On Clicking the Hold Button BackgroundCallCard::holdButtonClick

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: telephony

Who can subscribe: any user

The event BackgroundCallCard::holdButtonClick is triggered when the operator clicks the hold button.

The event operates within the application in the placement PAGE_BACKGROUND_WORKER.

What the Handler Receives

Data is passed to the callback BX24.placement.bindEvent

callback(true);

Event Handler Parameters

Required parameters are marked with *

Parameter
type

Description

eventData*
boolean

The current hold status after the button is clicked.

Possible values:

  • true — on hold
  • false — hold released

Event Subscription Parameters

Required parameters are marked with *

Name
type

Description

PLACEMENT*
string

The name of the interface event.

For this event — BackgroundCallCard::holdButtonClick

HANDLER*
string

The URL of the event handler for calling placement.bindEvent

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"PLACEMENT":"BackgroundCallCard::holdButtonClick","HANDLER":"**your_handler_url_here**"}' \
        "https://**put_your_bitrix24_address.com**/rest/placement.bindEvent?auth=**put_access_token_here**"
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'placement.bindEvent',
            params: {
              PLACEMENT: 'BackgroundCallCard::holdButtonClick',
              HANDLER: '**your_handler_url_here**',
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('placement.bindEvent result:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- 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>
          async function bindHoldButtonClickEvent() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'placement.bindEvent',
                params: {
                  PLACEMENT: 'BackgroundCallCard::holdButtonClick',
                  HANDLER: '**your_handler_url_here**',
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('placement.bindEvent result:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', bindHoldButtonClickEvent)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bindEvent',
                    [
                        'PLACEMENT' => 'BackgroundCallCard::holdButtonClick',
                        'HANDLER' => '**your_handler_url_here**'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'placement.bindEvent',
            {
                PLACEMENT: 'BackgroundCallCard::holdButtonClick',
                HANDLER: '**your_handler_url_here**'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'placement.bindEvent',
            [
                'PLACEMENT' => 'BackgroundCallCard::holdButtonClick',
                'HANDLER' => '**your_handler_url_here**'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Continue Learning

Previous
When Clicking the Mute Button
Next
When Clicking the Close Call Detail Form Button