Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The entry function of the plugin always receives a context object which contains essential information like phone number, user id, etc.

The context object always (in case of every event) contains the following properties:

Name

Type

Notes

callStarted

boolean

True if the call has engaged

customer

object

If a customer was picked by phone number (either automatically or manually by the agent) then it contains the details of that. The object has the following properties:

  • logicalName: entity name (account or contact)

  • id: primary key

  • name: display name

direction

int

  • 0: inbound

  • 1: outbound

userId

string

Enreach Cloud user id of agent

crmUserId

string

CRM user id of agent

phoneNumber

string

Phone number the call is engaged to

isDirty

boolean

True if the currently displayed form is dirty

callInitiatedFrom

object

Object reference of entity where the call was initiated from, in case of Click-to-dial event. The object has the following properties:

  • logicalName: entity name (account or contact)

  • id: primary key of entity

  • name: display name

  • fieldName: the field where the user clicked the phone icon

  • format: data format

customerSearchResults

object

An object storing account and contact search results by phone number. Can be used to customize multiple matches grid. For additional information, see the relevant page.