Call Card Tab CALL_CARD

Placement Code

Location

CALL_CARD

Item in the call card tab

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

String identifier of the application that registered the widget handler

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

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

PLACEMENT*
string

Code for the widget embedding location. 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 embedding location 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 entity 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 widget embedding location and object the widget handler was invoked.

Parameter

Description

CALL_ID*
string

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

PHONE_NUMBER*
string

The phone number of the client with whom the conversation is taking place.

LINE_NUMBER
string

The company phone number used to talk to the client.

LINE_NAME
string

The name of the company phone line used to talk to the client.

Lines are added by applications for integrating telephony using the telephony.externalLine.add method and are used for user convenience in Sales Intelligence.

CRM_ENTITY_TYPE
integer

Type of the CRM entity to which the current call is linked.

Knowing the type and identifier of the CRM entity (specified in the CRM_ENTITY_ID parameter), you can retrieve information about the entity.

CRM_ENTITY_ID
string

The identifier of the CRM entity to which the current call is linked.

Knowing the type (specified in the CRM_ENTITY_TYPE parameter) and the identifier of the CRM entity (specified in the CRM_ENTITY_ID parameter), you can retrieve information about the entity using the corresponding methods:

• any object type crm.item.get with entityTypeId = '1' for leads, '2' for deals, and etc.
• lead crm.lead.get
• deal crm.deal.get
• contact crm.contact.get
• company crm.company.get
• estimate crm.quote.get

CRM_ACTIVITY_ID
string

The identifier of the CRM activity associated with the current call.

Can be used to obtain additional information using the user.get method.

CALL_DIRECTION*
string

Defines the type of call. Can take the following values:

• 'incoming', incoming call;
• 'outcoming', outgoing call

CALL_STATE
string

Defines the state of the call. Can take the following values:

• 'connected', active call;

Other possible values will be published later.

CALL_LIST_MODE
string

Indicates whether the call is part of a call campaign or not.

Can take the following values:

• False, the call is not part of a call campaign;
• True, the call is made as part of a call campaign