Event of Call End ONVOXIMPLANTCALLEND

Scope: telephony

Who can subscribe: any user

The ONVOXIMPLANTCALLEND event is triggered when a call ends and the call information is recorded in the history.

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": "ONVOXIMPLANTCALLEND",
            "event_handler_id": "1061",
            "data": {
                "CALL_ID": "externalCall.7b0c7de811455ef32b18dc5917e4306a.1773239327",
                "CALL_TYPE": "1",
                "PHONE_NUMBER": "+19061234567",
                "PORTAL_NUMBER": "REST_APP:",
                "PORTAL_USER_ID": "1269",
                "CALL_DURATION": "0",
                "CALL_START_DATE": "2026-03-11T17:28:46+02:00",
                "COST": "0",
                "COST_CURRENCY": "",
                "CALL_FAILED_CODE": "304",
                "CALL_FAILED_REASON": "Call canceled",
                "CRM_ACTIVITY_ID": "7953"
            },
            "ts": "1773239624",
            "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 — ONVOXIMPLANTCALLEND

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 the authorization parameters of the user on behalf of whom the event was triggered.

The structure is described below

Parameter data

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

PHONE_NUMBER
string

Phone number of the subscriber for an incoming call or the number the operator is calling for an outgoing call

PORTAL_NUMBER
string

Number that received the incoming call or the number from which the outgoing call was made

PORTAL_USER_ID
integer

Identifier of the operator associated with the call

CALL_DURATION
integer

Duration of the call in seconds

CALL_START_DATE
datetime

Date and time the call started in ISO-8601 format

COST
double

Cost of the call

COST_CURRENCY
string

Currency of the call

CALL_FAILED_CODE
string

Call completion code.

Possible values:

  • 200 — successful call
  • 304 — missed call
  • 603 — declined
  • 603-S — call canceled
  • 403 — forbidden
  • 404 — invalid number
  • 486 — busy
  • 484 — direction unavailable
  • 503 — direction unavailable
  • 480 — temporarily unavailable
  • 402 — insufficient funds
  • 423 — blocked
  • OTHER — undefined

CALL_FAILED_REASON
string

Text description of the call completion code

CRM_ACTIVITY_ID
integer

Identifier of the CRM activity associated with the call

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 the Conversation Starts
Next
Overview of Methods