On Clicking the Mute Button of BackgroundCallCard::muteButtonClick

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::muteButtonClick is triggered when the operator clicks the microphone control button.

The event operates within the context of 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 state of the microphone after the button is pressed.

Possible values:

  • true — muted
  • false — unmuted

Event Subscription Parameters

Required parameters are marked with *

Name
type

Description

PLACEMENT*
string

The name of the interface event.

For this event — BackgroundCallCard::muteButtonClick

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::muteButtonClick","HANDLER":"**your_handler_url_here**"}' \
        "https://**put_your_bitrix24_address**/rest/placement.bindEvent?auth=**put_access_token_here**"
        
BX24.placement.bindEvent('BackgroundCallCard::muteButtonClick', function (eventData) {
            console.log(eventData);
        });
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bindEvent',
                    [
                        'PLACEMENT' => 'BackgroundCallCard::muteButtonClick',
                        '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::muteButtonClick',
                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::muteButtonClick',
                'HANDLER' => '**your_handler_url_here**'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Continue Learning

Previous
When Saving a Comment in the Call Detail Form
Next
When Clicking the Hold Call Button