Get Call Status getStatus

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 getStatus method returns the current data of the call card.

The method operates within the application context in the CALL_CARD placement.

Method Parameters

Required parameters are marked with *

Name
type

Description

PLACEMENT*
string

The name of the interface command.

For this method — getStatus

PARAMS*
object

The parameters object for the command.

For this method, an empty object is passed: {}

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

BX24.placement.call('getStatus', {}, function (result) {
            console.log(result);
        });

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

Response Handling

{
            "CALL_ID": "E45D40253D1C2D2F.1774588815.822533",
            "PHONE_NUMBER": "+19999999666",
            "LINE_NUMBER": "reg151083",
            "LINE_NAME": "",
            "CRM_ENTITY_TYPE": "CONTACT",
            "CRM_ENTITY_ID": 797,
            "CRM_ACTIVITY_ID": "",
            "CRM_BINDINGS": [
                {
                "ENTITY_TYPE": "DEAL",
                "ENTITY_ID": 4615
                },
                {
                "ENTITY_TYPE": "COMPANY",
                "ENTITY_ID": 643
                }
            ],
            "CALL_DIRECTION": "outgoing",
            "CALL_STATE": "idle",
            "CALL_LIST_MODE": false
        }

Returned Data

Name `type`	Description
CALL_ID `string`	The identifier of the call
PHONE_NUMBER `string`	The client's number
LINE_NUMBER `string`	The line number
LINE_NAME `string`	The name of the line
CRM_ENTITY_TYPE `string`	The type of the current CRM object
CRM_ENTITY_ID `integer`	The identifier of the current CRM object
CRM_ACTIVITY_ID `integer`	The identifier of the CRM activity
CRM_BINDINGS `object[]`	The bindings of the call to CRM objects (detailed description)
CALL_DIRECTION `string`	The direction of the call. Possible values: `incoming` — incoming call `outgoing` — outgoing call `callback` — callback
CALL_STATE `string`	The state of the call. Possible values: `idle` — no connection `connecting` — establishing connection `connected` — connection established
CALL_LIST_MODE `boolean`	Indicator of the dialing mode

CRM_BINDINGS Parameter

Name `type`	Description
ENTITY_TYPE `string`	The type of the CRM object
ENTITY_ID `integer`	The identifier of the CRM object

Error Handling

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

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 `CALL_CARD` placement

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

Overview of Methods and Events

Disable Auto-Close

Get Call Status getStatus

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

CRM_BINDINGS ParameterCRM_BINDINGS Parameter

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning