Callback Request Event ONEXTERNALCALLBACKSTART

Scope: telephony

Who can subscribe: any user

The event ONEXTERNALCALLBACKSTART is triggered when a visitor fills out the CRM callback form. Your application must be selected as the callback line in the form 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": "ONEXTERNALCALLBACKSTART",
            "event_handler_id": "1053",
            "data": {
                "PHONE_NUMBER": "+14151234567",
                "TEXT": "A callback has been requested from the website, connecting you with the client",
                "VOICE": "deinternalfemale",
                "CRM_ENTITY_TYPE": "CONTACT",
                "CRM_ENTITY_ID": "5785",
                "LINE_NUMBER": "7"
            },
            "ts": "1773234727",
            "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 — ONEXTERNALCALLBACKSTART

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 to call back

TEXT
string

The text that should be spoken to the responsible party before the call begins

VOICE
string

Voice identifier for speech synthesis

CRM_ENTITY_TYPE
string

Type of the related CRM object

CRM_ENTITY_ID
integer

Identifier of the CRM object, the type of which is specified in CRM_ENTITY_TYPE

LINE_NUMBER
string

The number of the external line through which the callback was requested

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 exploring

Previous
When Clicking on a Phone Number
Next
Using SIP and Built-in Telephony