Menu Item in Call Analytics TELEPHONY_ANALYTICS_MENU

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 report to the call analytics menu. The user selects the item in the menu, and the application interface opens instead of a built-in report.

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

Placement Code	Location
`TELEPHONY_ANALYTICS_MENU`	Menu item in call analytics

Where to Find It in the Interface

Open the Telephony section and go to the Call statistics tab — the page address is /report/telephony/. The statistics open in a slider. The application item is displayed in the menu on the left, as a separate group below the built-in reports.

Menu item in call analytics

The item name and the group name are set with the parameters of the placement.bind method during registration.

Parameter `type`	Description
TITLE `string`	The item name in the menu. If the parameter is not passed, the application name is displayed instead
GROUP_NAME `string`	The name of the group the item belongs to. If the parameter is not passed, the item goes to the Applications group. Items of several applications with the same `GROUP_NAME` are collected into a single group

Both names are translated into the user's language with the LANG_ALL parameter — as in the examples below.

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] => b308bae53869a142613f8852c1bd3992
            [AUTH_ID] => 4f77bb6600705a0700005a4b00000001f0f107cbd329fa1d8ea5455dc22653d12e7d54
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 3ff6e26600705a0700005a4b00000001f0f10746f1299672a11fa3729c3ba98ebd86d2
            [SERVER_ENDPOINT] => https://oauth.bitrix.info/rest/
            [APPLICATION_TOKEN] => 5b2f8c1d7e3a9046b8c5d2f1a7e3b904
            [APPLICATION_SCOPE] => telephony,placement
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => TELEPHONY_ANALYTICS_MENU
            [PLACEMENT_OPTIONS] => {"URI":"\/report\/telephony\/?IFRAME=Y&IFRAME_TYPE=SIDE_SLIDER"}
        )

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

This placement has no own keys. The call context carries only the universal URI key — the address of the analytics page the widget is opened from. The analytics open in a slider, so the address contains the IFRAME and IFRAME_TYPE parameters.

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.

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "PLACEMENT": "TELEPHONY_ANALYTICS_MENU",
            "HANDLER": "https://your-domain.com/widgets/telephony-analytics-handler.php",
            "TITLE": "External telephony report",
            "GROUP_NAME": "My telephony",
            "LANG_ALL": {
              "en": {
                "TITLE": "External telephony report",
                "GROUP_NAME": "My telephony"
              },
              "de": {
                "TITLE": "Bericht zur externen Telefonie",
                "GROUP_NAME": "Meine Telefonie"
              }
            },
            "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: 'TELEPHONY_ANALYTICS_MENU',
              HANDLER: 'https://your-domain.com/widgets/telephony-analytics-handler.php',
              TITLE: 'External telephony report',
              GROUP_NAME: 'My telephony',
              LANG_ALL: {
                en: {
                  TITLE: 'External telephony report',
                  GROUP_NAME: 'My telephony',
                },
                de: {
                  TITLE: 'Bericht zur externen Telefonie',
                  GROUP_NAME: 'Meine Telefonie',
                },
              },
            },
            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 bindTelephonyAnalyticsMenu() {
            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: 'TELEPHONY_ANALYTICS_MENU',
                  HANDLER: 'https://your-domain.com/widgets/telephony-analytics-handler.php',
                  TITLE: 'External telephony report',
                  GROUP_NAME: 'My telephony',
                  LANG_ALL: {
                    en: {
                      TITLE: 'External telephony report',
                      GROUP_NAME: 'My telephony',
                    },
                    de: {
                      TITLE: 'Bericht zur externen Telefonie',
                      GROUP_NAME: 'Meine Telefonie',
                    },
                  },
                },
                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', bindTelephonyAnalyticsMenu)
        </script>

try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bind',
                    [
                        'PLACEMENT' => 'TELEPHONY_ANALYTICS_MENU',
                        'HANDLER' => 'https://your-domain.com/widgets/telephony-analytics-handler.php',
                        'TITLE' => 'External telephony report',
                        'GROUP_NAME' => 'My telephony',
                        'LANG_ALL' => [
                            'en' => [
                                'TITLE' => 'External telephony report',
                                'GROUP_NAME' => 'My telephony',
                            ],
                            'de' => [
                                'TITLE' => 'Bericht zur externen Telefonie',
                                'GROUP_NAME' => 'Meine Telefonie',
                            ],
                        ],
                    ]
                );
        
            $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: 'TELEPHONY_ANALYTICS_MENU',
                HANDLER: 'https://your-domain.com/widgets/telephony-analytics-handler.php',
                TITLE: 'External telephony report',
                GROUP_NAME: 'My telephony',
                LANG_ALL: {
                    en: {
                        TITLE: 'External telephony report',
                        GROUP_NAME: 'My telephony'
                    },
                    de: {
                        TITLE: 'Bericht zur externen Telefonie',
                        GROUP_NAME: 'Meine Telefonie'
                    }
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'placement.bind',
            [
                'PLACEMENT' => 'TELEPHONY_ANALYTICS_MENU',
                'HANDLER' => 'https://your-domain.com/widgets/telephony-analytics-handler.php',
                'TITLE' => 'External telephony report',
                'GROUP_NAME' => 'My telephony',
                'LANG_ALL' => [
                    'en' => [
                        'TITLE' => 'External telephony report',
                        'GROUP_NAME' => 'My telephony',
                    ],
                    'de' => [
                        'TITLE' => 'Bericht zur externen Telefonie',
                        'GROUP_NAME' => 'Meine Telefonie',
                    ],
                ],
            ]
        );
        
        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":  "TELEPHONY_ANALYTICS_MENU",
        	"HANDLER":    "https://your-domain.com/widgets/telephony-analytics-handler.php",
        	"TITLE":      "External telephony report",
        	"GROUP_NAME": "My telephony",
        	"LANG_ALL": b24.Params{
        		"ru": b24.Params{
        			"TITLE":      "External telephony report",
        			"GROUP_NAME": "My telephony",
        		},
        		"en": b24.Params{
        			"TITLE":      "External telephony report",
        			"GROUP_NAME": "My telephony",
        		},
        	},
        })
        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 item in the analytics menu	Complete the application installation and reload the Bitrix24 page: the list of menu items is assembled when the page loads

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

Continue Your Exploration

Was the article helpful?

Tab in the Call Card

WebRTC

Menu Item in Call Analytics TELEPHONY_ANALYTICS_MENU

Where the Widget is EmbeddedWhere the Widget is Embedded

Where to Find It in the InterfaceWhere to Find It in the Interface

What the Handler ReceivesWhat the Handler Receives

PLACEMENT_OPTIONSPLACEMENT_OPTIONS

Code ExamplesCode Examples

Common MistakesCommon Mistakes

Continue Your ExplorationContinue Your Exploration