Widget in the CONTACT_CENTER

We are still updating this page

Some data may be missing — we will fill it in shortly.

Scope: contact_center

You can add your item ("square") to the Contact Center list.

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

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

Where the widget is embedded

Widget code

Location

CONTACT_CENTER

Item ("square") in the Contact Center list

What the handler receives

Data is transmitted as a POST request


        'DOMAIN': 'xxx.bitrix24.com'
        'PROTOCOL': 1
        'LANG': 'en'
        'APP_SID': '99c80eff6378726287350416ee5fef0'
        'AUTH_ID': '6061e72600631fcd00005a4b00000001f0f1076700000000f69dd5fc643d9ce2fdbc1'
        'AUTH_EXPIRES': 3600
        'REFRESH_ID': '50e00aa340631fcd00005a4b00000001f0f1071111116580a5b83c2de639ef28c12'
        'member_id': 'da45a03b265ed12127f8a258d793cc5d'
        'status': 'L'
        'PLACEMENT': 'CRM_DEAL_DETAIL_TAB'
        'PLACEMENT_OPTIONS': '{"ID":"3443"}'

Required parameters are marked with *

Parameter
type

Description

DOMAIN*
string

The address of Bitrix24 where the widget handler was called

PROTOCOL*
string

Secure or non-secure HTTP protocol:

  • 0 - HTTP
  • 1 - HTTPS

LANG*
string

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

APP_SID
string

String identifier of the application that registered the widget handler

AUTH_ID
string

Authorization token OAuth 2 issued for the user who called 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 called the widget. Can be used to refresh the authorization token on behalf of this user

member_id*
string

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

status
string

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

PLACEMENT*
string

Code of the widget placement. 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 widget placement your handler was called in each case

PLACEMENT_OPTIONS
string

Additional data in the form of a JSON string that defines the context of the widget execution. In this case, it is an array containing the numeric identifier of the CRM element in the detail form where the widget handler was called. The PLACEMENT_OPTIONS parameter along with the PLACEMENT parameter allows you to accurately determine for which specific CRM object the widget handler was called

Continue exploring

Previous
Emoji Collection
Next
Universal Widgets