Set Call on Hold Using the CallCardSetHold Application

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 execute the method: any user

The CallCardSetHold method enables or disables call hold in the card.

The method operates within the context of the application in the PAGE_BACKGROUND_WORKER placement.

Method Parameters

Required parameters are marked with *

Name
type

Description

PLACEMENT*
string

The name of the interface command.

For this method — CallCardSetHold

PARAMS*
object

The parameters object for the command.

For this method, an object with the held property is passed (detailed description)

PARAMS Parameter

Name
type

Description

held*
boolean

Control of hold status.

Possible values:

true — put the call on hold
false — take the call off hold

Code Examples

How to Use Examples in Documentation

It is recommended to call the method after the BackgroundCallCard::initialized event.

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"PLACEMENT":"CallCardSetHold","PARAMS":{"held":true}}' \
          "https://**put_your_bitrix24_address**/rest/placement.call?auth=**put_access_token_here**"

BX24.placement.call('CallCardSetHold', { held: true }, function(result) {
            console.log(result);
        });

try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.call',
                    [
                        'PLACEMENT' => 'CallCardSetHold',
                        'PARAMS' => [
                            'held' => true,
                        ]
                    ]
                );
        
            $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.call',
            {
                PLACEMENT: 'CallCardSetHold',
                PARAMS: {
                    held: true
                }
            },
            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.call',
            [
                'PLACEMENT' => 'CallCardSetHold',
                'PARAMS' => [
                    'held' => true,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

[]

Returned Data

An empty array upon a successful call.

Error Handling

REST Call Error

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Application context required"
        }

Interface Call Error

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`WRONG_AUTH_TYPE`	Application context required	The method was called outside the application context in the `PAGE_BACKGROUND_WORKER` placement
`Call card is undefined`	Call card is unavailable	No active call card available for management
`missing field held`	Required parameter `held` not provided	Parameter error in the desktop scenario. Due to callback implementation specifics, an additional successful response `[]` may occur

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Mute Operator's Microphone from the Application

Change Call Card Interface State from the Application

Set Call on Hold Using the CallCardSetHold Application

Method ParametersMethod Parameters

PARAMS ParameterPARAMS Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

REST Call ErrorREST Call Error

Interface Call ErrorInterface Call Error

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning