ONVOXIMPLANTCALLINIT Call Initialization Event

Scope: telephony

Who can subscribe: any user

The ONVOXIMPLANTCALLINIT event is triggered when a call is initialized: either when an incoming call is received or when an outgoing call is initiated.

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": "ONVOXIMPLANTCALLINIT",
            "event_handler_id": "1057",
            "data": {
                "CALL_ID": "5E316880469A6376.1773306964.8740011",
                "CALL_TYPE": "1",
                "ACCOUNT_SEARCH_ID": "reg150908",
                "PHONE_NUMBER": "+19999999666",
                "CALLER_ID": "reg150908"
            },
            "ts": "1773306964",
            "auth": {
                "access_token": "s7p6eclrvim9da98dt9ch94ekreb52sv",
                "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": "a223c6b9410f85df73e9377d6c4f7213",
                "refresh_token": "4s386p3q0tr8dy09xvmt96234v3dljg8",
                "application_token": "52610fefc120afg4b628cc82d6298cce"
            }
        }
        
{
            "event": "ONVOXIMPLANTCALLINIT",
            "event_handler_id": "1057",
            "data": {
                "CALL_ID": "externalCall.7b0c7de811455ef32b18dc5917e4306a.1773239327",
                "CALL_TYPE": "1",
                "CALLER_ID": "+19061234567",
                "REST_APP_ID": "3"
            },
            "ts": "1773239326",
            "auth": {
                "access_token": "s7p6eclrvim9da98dt9ch94ekreb52sv",
                "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": "a223c6b9410f85df73e9377d6c4f7213",
                "refresh_token": "4s386p3q0tr8dy09xvmt96234v3dljg8",
                "application_token": "52610fefc120afg4b628cc82d6298cce"
            }
        }

Parameter
type

Description

event
string

Symbolic code of the event.

In this case — ONVOXIMPLANTCALLINIT

event_handler_id
string

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 user authorization parameters under which the event was triggered.

The structure is described below

Data Parameter

Parameter
type

Description

CALL_ID
string

Identifier of the call

CALL_TYPE
integer

Type of the call.

Possible values:

  • 1 — outgoing
  • 2 — incoming
  • 3 — incoming with redirection
  • 4 — callback
  • 5 — informational call

ACCOUNT_SEARCH_ID
string

Identifier of the line.

Possible values:

  • XXX — for rented numbers
  • regXXX — for cloud PBXs
  • sipXXX — for office PBXs

This field is returned when using rented numbers or SIP

PHONE_NUMBER
string

The number the operator is calling for an outgoing call, or the number the subscriber is calling for an incoming call.

This field is returned when using rented numbers or SIP

CALLER_ID
string

Identifier of the line for an outgoing call or the client's phone number for an incoming call

REST_APP_ID
integer

Identifier of the application associated with the call.

This field is returned when using the telephony application

Auth Parameter

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 Learning

Previous
Overview of Events
Next
When the Conversation Starts