Call Card Tab CALL_CARD

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

The widget adds its own tab to the call card. The handler is invoked during a conversation and receives the call context: call identifier, phone number, call direction and state, and the linked CRM items.

The placement code is specified in the PLACEMENT parameter of the placement.bind method.

The widget is not displayed in the interface until the application installation is complete. Check the application installation

Where the Widget is Embedded

Placement Code

Location

CALL_CARD

Tab in the call card

Where to Find It in the Interface

The call card appears for the employee when a conversation starts. The application tab is displayed on the right side of the card, in the same row as the built-in tabs.

The tab name is set with a parameter of the placement.bind method during registration.

Parameter
type

Description

TITLE
string

The tab name in the call card. If the parameter is not passed, the application name is displayed instead

The name is translated into the user's language with the LANG_ALL parameter — as in the examples below.

Tab in the call card

To check the widget, you need a call. External telephony raises one with the telephony.externalCall.register method and the SHOW = 1 parameter, or with the telephony.externalCall.show method for a call that is already registered.

The list of card tabs is built when the Bitrix24 page loads. If you registered the widget while the page was already open, reload it — otherwise the new tab will not appear in the card.

What the Handler Receives

Data is sent in a POST request: some parameters come in the handler URL query string, the rest in the request body

Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => 588b8a98e848778a4ffb38fbcf70f2b9
            [AUTH_ID] => 4172bb6600705a0700005a4b00000001f0f107c42ca5bd5f61030c5d9c3e4d60d11b5a
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 31f1e26600705a0700005a4b00000001f0f107b1918506d8a2ed9ecf76e8fdac962471
            [SERVER_ENDPOINT] => https://oauth.bitrix.info/rest/
            [APPLICATION_TOKEN] => 5b2f8c1d7e3a9046b8c5d2f1a7e3b904
            [APPLICATION_SCOPE] => telephony,crm,placement
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => CALL_CARD
            [PLACEMENT_OPTIONS] => {"CALL_ID":"externalCall.c3ee67f1a63f6e6117c230ab59cc49ea.1723556778","PHONE_NUMBER":"+4930123456","LINE_NUMBER":"+49 30 000-00-00","LINE_NAME":"+49 30 000-00-00","CRM_ENTITY_TYPE":"COMPANY","CRM_ENTITY_ID":"17","CRM_ACTIVITY_ID":"undefined","CRM_BINDINGS":[{"ENTITY_TYPE":"DEAL","ENTITY_ID":"25"},{"ENTITY_TYPE":"COMPANY","ENTITY_ID":"17"}],"CALL_DIRECTION":"incoming","CALL_STATE":"connected","CALL_LIST_MODE":"false","URI":"\/crm\/company\/details\/17\/"}
        )

Required parameters are marked with *

Parameters in the Handler URL Query String

Parameter
type

Description

DOMAIN*
string

The Bitrix24 address where the widget handler was invoked

PROTOCOL*
string

Secure or non-secure HTTP protocol:

  • 0 - HTTP
  • 1 - HTTPS

LANG*
string

The user interface language of Bitrix24 that invoked the widget. You can localize the interface language in your widget based on this value

APP_SID*
string

Application session identifier. Bitrix24 generates a new one each time the widget is rendered and uses it to link the js library with the application environment

Parameters in the POST Request Body

Parameter
type

Description

AUTH_ID
string

Authorization token OAuth 2 issued for the user who invoked the widget. Can be used for REST API calls on behalf of this user

AUTH_EXPIRES
integer

Time in seconds after which the authorization token will become invalid

REFRESH_ID
string

Refresh token OAuth 2 issued for the user who invoked the widget. Can be used to refresh the authorization token on behalf of this user

SERVER_ENDPOINT*
string

Address of the Bitrix24 authorization server needed to refresh OAuth 2 tokens

APPLICATION_TOKEN*
string

Application token. The same value is passed in the application_token parameter when event handlers are invoked. The widget handler can use it to verify that the request came from Bitrix24

APPLICATION_SCOPE*
string

List of scopes granted to the application, separated by commas. Shows which REST API methods are available with the authorization token received

member_id*
string

Unique string identifier of Bitrix24 where the widget handler was invoked.

status
string

Type of application that registered the handler for this widget. Accepts values:

  • L - local application
  • F - free mass-market application
  • D - demo version of a mass-market application
  • T - trial version of a mass-market application, time-limited
  • P - paid mass-market application

PLACEMENT*
string

The placement code. You can use the same handler URL for all your widgets. The value that Bitrix24 will report in the PLACEMENT parameter will help determine from which specific placement your handler was invoked in each case

PLACEMENT_OPTIONS
string

Additional data in the form of a JSON string that defines the context of the widget execution. For example, this could be an array containing the numeric identifier of the CRM object in the detail form where the widget handler was invoked, etc. The PLACEMENT_OPTIONS parameter, along with the PLACEMENT parameter, allows you to accurately determine for which specific placement and object the widget handler was invoked

Bitrix24 adds a URI key to PLACEMENT_OPTIONS — the path with the query string of the page from which the widget was opened. It arrives for any placement, along with the keys of that placement itself. The key is absent if the browser did not send the Referer header or if the widget was opened from a page on a different domain.

How to Parse the Call Context

PLACEMENT_OPTIONS arrives as a JSON string, not as an array: parse it on the handler side before use. The set of keys is specific to each placement and is described in the PLACEMENT_OPTIONS section of this page.

$placement = $_POST['PLACEMENT'] ?? '';
        $options = json_decode($_POST['PLACEMENT_OPTIONS'] ?? '{}', true);
        
options = json.loads(request.form.get("PLACEMENT_OPTIONS", "{}") or "{}")

In B24JsSDK, there is no need to parse the string: the $b24.placement.options property returns a ready object, and $b24.placement.placement returns the placement code.

What the Handler Must Return

The handler responds with a regular HTML page — Bitrix24 displays it in a frame in place of the widget. The page must allow embedding: if the application server sends the X-Frame-Options or Content-Security-Policy headers that prohibit framing, an empty area remains in place of the widget. How to fix it is described in the article Site Does Not Allow Connection.

PLACEMENT_OPTIONS

The value of PLACEMENT_OPTIONS is passed as a JSON string with the call context.

Required parameters are marked with *

Parameter

Description

CALL_ID*
string

The identifier of the call during which the widget was opened.

The telephony.externalCall.register method returns the same identifier. It is accepted by the methods that finish a call and attach a call recording

PHONE_NUMBER
string

The phone number of the client the conversation is held with.

The number arrives in normalized form, without spaces or separators. If the client's number is unknown, the key is not passed

LINE_NUMBER
string

The company's phone number that received the call or that the call is made from

LINE_NAME
string

The name of the company's phone line.

Lines are added by telephony integration applications with the telephony.externalLine.add method and are used in Sales Intelligence. If the line has no name, the key carries its number

CRM_ENTITY_TYPE
string

The symbolic code of the CRM item type the call is linked to: LEAD, DEAL, CONTACT, COMPANY.

This is entityTypeName, not the numeric type identifier. If the call is not linked to CRM, the key arrives empty

CRM_ENTITY_ID
string

The identifier of the CRM item the call is linked to.

Knowing the type and the identifier, you can retrieve the item data:

If the call is not linked to CRM, the key carries 0

CRM_BINDINGS
array

All CRM items linked to the call. The composition of an array element is described below.

The CRM_ENTITY_TYPE and CRM_ENTITY_ID keys name the primary item only. If the call is linked to several items at once — for example, to a company and its deal — the full list arrives in CRM_BINDINGS.

If there are no linked items, the key is not passed at all

CRM_ACTIVITY_ID
string

The identifier of the CRM activity created for this call.

The crm.activity.get method returns the activity data.

If no activity was created for the call, the key carries the string undefined. Check the value before using it

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 at the moment the widget is opened. Possible values:

  • idle — the conversation has not started yet
  • connecting — the connection is being established
  • connected — active conversation

CALL_LIST_MODE
string

Indicates whether the call is made as part of a call campaign. The value arrives as a string: true or false

Along with these keys, the universal URI key arrives — it is described above, in the standard data.

Composition of CRM_BINDINGS

Key
type

Description

ENTITY_TYPE
string

Symbolic code of the CRM item type: LEAD, DEAL, CONTACT, COMPANY

ENTITY_ID
string

Identifier of the CRM item

This placement does not support the OPTIONS parameter of the placement.bind method: the values passed are not retained, and placement.get returns an empty array.

Managing the Call Card From the Handler

The handler can do more than read the context: it can also work with the call card from the browser — retrieve the data of the current call, disable and re-enable the automatic closing of the card, and track the change of the client and of the call state. The card commands and events are described in the Call Card CALL_CARD: Overview of Commands and Events section.

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "PLACEMENT": "CALL_CARD",
            "HANDLER": "https://your-domain.com/widgets/call-card-handler.php",
            "TITLE": "Customer profile",
            "LANG_ALL": {
              "en": {
                "TITLE": "Customer profile"
              },
              "de": {
                "TITLE": "Kundenprofil"
              }
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/placement.bind
        
// 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.bind',
            params: {
              PLACEMENT: 'CALL_CARD',
              HANDLER: 'https://your-domain.com/widgets/call-card-handler.php',
              TITLE: 'Customer profile',
              LANG_ALL: {
                en: {
                  TITLE: 'Customer profile',
                },
                de: {
                  TITLE: 'Kundenprofil',
                },
              },
            },
            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 bound successfully:', 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 bindCallCard() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'placement.bind',
                params: {
                  PLACEMENT: 'CALL_CARD',
                  HANDLER: 'https://your-domain.com/widgets/call-card-handler.php',
                  TITLE: 'Customer profile',
                  LANG_ALL: {
                    en: {
                      TITLE: 'Customer profile',
                    },
                    de: {
                      TITLE: 'Kundenprofil',
                    },
                  },
                },
                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 bound successfully:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', bindCallCard)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bind',
                    [
                        'PLACEMENT' => 'CALL_CARD',
                        'HANDLER' => 'https://your-domain.com/widgets/call-card-handler.php',
                        'TITLE' => 'Customer profile',
                        'LANG_ALL' => [
                            'en' => [
                                'TITLE' => 'Customer profile',
                            ],
                            'de' => [
                                'TITLE' => 'Kundenprofil',
                            ],
                        ],
                    ]
                );
        
            $result = $response->getResponseData()->getResult();
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error binding placement: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'placement.bind',
            {
                PLACEMENT: 'CALL_CARD',
                HANDLER: 'https://your-domain.com/widgets/call-card-handler.php',
                TITLE: 'Customer profile',
                LANG_ALL: {
                    en: { TITLE: 'Customer profile' },
                    de: { TITLE: 'Kundenprofil' }
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'placement.bind',
            [
                'PLACEMENT' => 'CALL_CARD',
                'HANDLER' => 'https://your-domain.com/widgets/call-card-handler.php',
                'TITLE' => 'Customer profile',
                'LANG_ALL' => [
                    'en' => [
                        'TITLE' => 'Customer profile',
                    ],
                    'de' => [
                        'TITLE' => 'Kundenprofil',
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
        	"PLACEMENT": "CALL_CARD",
        	"HANDLER":   "https://your-domain.com/widgets/call-card-handler.php",
        	"TITLE":     "Customer profile",
        	"LANG_ALL": b24.Params{
        		"ru": b24.Params{
        			"TITLE": "Customer profile",
        		},
        		"en": b24.Params{
        			"TITLE": "Customer profile",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("placement.bind: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it into a struct
        // matching the response shape from the "Response Handling" section of the placement.bind page.
        fmt.Printf("%s\n", res.Result)

Common Mistakes

Mistake

Solution

placement.bind returns WRONG_AUTH_TYPE with the description Application context required

Register the placement on behalf of an application. A placement cannot be bound with a webhook

placement.bind returns ERROR_PLACEMENT_NOT_FOUND

The placement code is specified incorrectly or the application has not been granted the telephony scope

placement.bind returns ERROR_ARGUMENT

Pass the required PLACEMENT and HANDLER parameters. The code of the empty field arrives in argument

The widget is registered, but there is no tab in the call card

Complete the application installation and reload the Bitrix24 page: the list of card tabs is assembled when the page loads

The handler does not find the activity identifier

If no activity has been created for the call, the string undefined arrives in CRM_ACTIVITY_ID. Check the value before using it

The handler does not recognize CRM_ENTITY_TYPE

The key carries the symbolic code of the type — LEAD, DEAL, CONTACT, COMPANY — not the numeric identifier

The widget does not see the second linked CRM item

The CRM_ENTITY_TYPE and CRM_ENTITY_ID keys name the primary item only. The full list of links arrives in CRM_BINDINGS

The error arrives in the response body — the code in the error field, the text in error_description:

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Current authorization type is denied for this method Application context required"
        }

Other registration error codes are listed in the "Possible Error Codes" section of the placement.bind page.

Continue Your Exploration

Previous
Overview of Placements
Next
Menu Item in Call Analytics