Skip to content

on-external-call-start.md

Latest commit

 

History

History
121 lines (98 loc) · 4.4 KB

on-external-call-start.md

File metadata and controls

121 lines (98 loc) · 4.4 KB
Raw

Event of Outgoing Call Start ONEXTERNALCALLSTART

{% note tip "" %}

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.

{% endnote %}

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 trigger the event, specify the application in the Default Number for Outgoing Calls field in the telephony settings or select it as the default application in the user settings.

{% note info "" %}

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

{% endnote %}

What the Handler Receives

Data is transmitted as a POST request {.b24-info}

{
    "event": "ONEXTERNALCALLSTART",
    "event_handler_id": "1055",
    "data": {
        "PHONE_NUMBER": "+494951234567",
        "PHONE_NUMBER_INTERNATIONAL": "+494951234567",
        "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 code of the event.

In this case — ONEXTERNALCALLSTART || || event_handler_id integer | Identifier of the event handler || || data object | Object with event data.

The structure is described below || || ts timestamp | Date and time of the event sent from the event queue || || auth object | Object containing authorization parameters of the user on behalf of whom the event was triggered.

The structure is described below || |#

Parameter data {#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 object, the type of which is specified in CRM_ENTITY_TYPE || |#

Parameter auth {#auth}

{% include notitle Auth parameters in events %}

Continue Learning