General Event Fields

payload.account When a call is initiated, Opentact will send out Call Init event to the websocket connection.

Here are all fields returned in the Call Init events:

Field NameDescription

timestamp

A record of the time of occurrence of a particular event.

message

A communication or statement conveyed from backend to frontend. Does it define the mode of Call at the present time & and ANI?DNIS too

type

It defines if the Even is related to Call state,SMS or balance related

payload.uuid

A unique UUID is generated based on Each event

payload.direction

It defines wheather the call is Inbound/Outbound.

payload.state

There are multiple state which defines the call status . for ex If call is rinign then State should be 'ringing', If call hits the End reccipient then state should be 'Live' etc.

payload.from

From which number call is coming [ANI ]

payload.to

To which number call goes [ DNIS ]

payload.created_on

Created on datetime

payload.modified_on

Last modified on datetime

payload.init_on

the time when call_state=init has been started

payload.duration

duration of the call till now

payload.type

Type of payload like CALLSCA

payload.tn.created_on

When TN was created

payload.tn.modified_on

When TN was modifed

payload.tn.delete_on

should be blank

payload.tn.tn

The Tn [ A DID ]

payload.sipcontrol_app.created_on

When Sip Control App was created

payload.sipcontrol_app.modified_on

When Sip control app was modifed

payload.sipcontrol_app.uuid

unique uuid of Sip Control App.

payload.sipcontrol_app.name

Name of Sip Control App.

payload.sipcontrol_app.is_active

It defines Wheather Sip is active or Not.

payload.sipcontrol_app.tech_prefix

payload.sipcontrol_app.shake_verify_policy

payload.sipcontrol_app.shaken_minimum_accepted_attest_lvl

payload.sipcontrol_app.auto_answer

payload.sipcontrol_app.webhook_url

payload.sipcontrol_app.webhook_method

payload.sipcontrol_app.webhook_request_timeout

payload.account.created_on

When account was created

payload.account.modified_on

The time when account was modified

payload.account.uuid

unique uuid of account

payload.account.email

email of the account

payload.account.name

name of the account

payload.account.level

It defines the level of the account

payload.account.deleted_on

should be null

payload.account.disbaled_on

should be null

payload.account.balance

Balance of the account

An example of the Call Init event is as follows:

Last updated