Event of Outgoing Call Start ONEXTERNALCALLSTART

Scope: telephony

Who can subscribe: any user

The ONEXTERNALCALLSTART event is triggered when a user clicks on a phone number in CRM entities to make an outgoing call through the selected telephony application.

To ensure the event is triggered, specify the application in the Default Outgoing Call Number field in the telephony settings or select it as the default application in the user settings.

Events will not be sent to the application until the installation is complete. Check the application installation

What the handler receives

Data is transmitted as a POST request

{
            "event": "ONEXTERNALCALLSTART",
            "event_handler_id": "1055",
            "data": {
                "PHONE_NUMBER": "+14155551234",
                "PHONE_NUMBER_INTERNATIONAL": "+14155551234",
                "EXTENSION": "",
                "USER_ID": "1269",
                "CALL_LIST_ID": "0",
                "LINE_NUMBER": "7",
                "IS_MOBILE": "0",
                "CALL_ID": "externalCall.89350264e026dace3f2b14d1f438257c.1773236989",
                "CRM_ENTITY_TYPE": "CONTACT",
                "CRM_ENTITY_ID": "797"
            },
            "ts": "1773236988",
            "auth": {
                "access_token": "s7p6eclrvim9da28dt9ch94ekreb52sv",
                "expires_in": "3600",
                "scope": "telephony",
                "domain": "some-domain.bitrix24.com",
                "server_endpoint": "https://oauth.bitrix.info/rest/",
                "status": "F",
                "client_endpoint": "https://example.bitrix24.com/rest/",
                "member_id": "a223c6b9410f85df78e9377d6c4f7213",
                "refresh_token": "4s386p3q0tr8dy89xvmt96234v3dljg8",
                "application_token": "51610fefc120afg4b628cc82d6298cce"
            }
        }

Parameter
type

Description

event
string

Symbolic event code.

In this case — ONEXTERNALCALLSTART

event_handler_id
integer

Identifier of the event handler

data
object

Object containing event data.

The structure is described below

ts
timestamp

Date and time the event was sent from the event queue

auth
object

Object containing the user's authorization parameters under which the event was triggered.

The structure is described below

Parameter data

Parameter
type

Description

PHONE_NUMBER
string

The phone number from which the user initiated the outgoing call

PHONE_NUMBER_INTERNATIONAL
string

The phone number in international format

EXTENSION
string

Extension number

USER_ID
integer

Identifier of the user for whom the external call needs to be registered

CALL_LIST_ID
integer

Identifier of the call list if the call was initiated from a call list

LINE_NUMBER
string

Number of the external line through which the call was requested

IS_MOBILE
string

Flag indicating that the call was initiated from a mobile application.

Possible values:

  • 0 - the call was not initiated from a mobile application
  • 1 - the call was initiated from a mobile application

CALL_ID
string

Identifier of the call created when registering the external call

CRM_ENTITY_TYPE
string

Type of the CRM entity from which the call was initiated

CRM_ENTITY_ID
integer

Identifier of the CRM entity whose type is specified in CRM_ENTITY_TYPE

Parameter auth

Required parameters are marked with *

Name
type

Description

access_token
string

Authorization token OAuth 2.0

expires_in
integer

Time in seconds until the token expires

scope*
string

Scope under which the event occurred

domain*
string

Address of Bitrix24 where the event occurred

server_endpoint*
string

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

status*
string

Status of the application that subscribed to this event:

client_endpoint*
string

Common path for REST API method calls for Bitrix24 where the event occurred

member_id*
string

Identifier of Bitrix24 where the event occurred

refresh_token
string

Token for extending authorization OAuth 2.0

application_token*
string

Token for secure event handling

Authorization tokens are not always passed to the event handler. If the hit that initiated the event could not be linked to a specific Bitrix24 user, the tokens are not passed. Always check the contents of the auth key in the code.

It is recommended to store tokens obtained earlier during the application installation. Use them when working with the application interface in the form of embeds, widgets, and so on.

Continue your exploration

Previous
Overview of Events
Next
When Filling Out a CRM Form