CallEvent

Notification Object
      ↪ CallEvent

Notification object for the following call events:

Name Notes

newCallEvent

For new calls (Only Admin)

callConnectedEvent

For calls that are connected (Only Admin)

callHungUpEvent

For calls that are hungup (Only Admin)

missedCallEvent

For missed calls

channelHungUpEvent

For channels that are hung up. The call is not hungup, only the channel. Can be used to notify a user that their channel is hungup (when someone else has picked up the call or when line hunting). Only caller or callee information is filled because to other side of the channel is gone. (Only Admin)

How to process

Call events are sended for calls that are new, connected, hungup or missed.
The missed call event can be used to show a missed call notification to an end user

The other call events are best used by third party applications that are interisted in these events.
Only administrators can receive these type of events, it’s recommended to open one websocket connection that listens to these events and process them in this third party application.

Attendant transfer call events
When a call is answered between Customer and UserA and UserA calls UserB and UserA transfers the Customer call to UserB, 3 hungup events are generated for the calls that are hung up (Cusomter → A, A →B and A → B again).
The hungup event of A → B is sended 2 times, keep this in mind when implementing this event.
The callId is the same, so it is needed to compare the callId.

To sum up

  • Customer C calls User A

  • User A calls User B

  • User A transfer Customer C call to User B

  • Hangup event for call Customer C → User A

  • Hangup event for call User A → User B (same callId)

  • Hangup event for call User A → User B (same callId)

  • Call ended between Customer C and User B

  • Hangup event for call Customer C → User B

Fields

Name Type Notes

initiation

Initiation

How is the call initiated

date

datetime

notNull

The date on which the call was initiated

callId

String

notNull

The unique id that identifies this call

calleeFlowId

String

notNull

The callee flow id follows the flow of the call and is the same during the whole call flow (transfer, fall back, etc)

calleeUser

String

The callee user profile object id

calleeUserAddressable

String

the callee user profile addressable object id

calleePhoneNumber

String

The callee phone number

calleeAddressable

String

The callee addressable object id

calleeAddressableSyncId

String

The callee addressable sync id

calleeAddressableSyncSource

String

The callee addressable sync source

calleeCallLogOid

String

The callee call log object id

calleePhoneLineOid

String

The callee phone line object id

callerFlowId

String

notNull

The caller flow id follows the flow of the call and is the same during the whole call flow (transfer, fall back, etc)

callerUser

String

the caller user profile object id

callerUserAddressable

String

The caller user profile addressable object id

callerPhoneNumber

String

The caller phone number

callerAddressable

String

The caller addressable object id

callerAddressableSyncId

String

The caller addressable sync id

callerAddressableSyncSource

String

The caller addressable sync source

callerCallLogOid

String

The caller call log object id

duration

String

The duration of the call in seconds, only filled on callHungUpEvent