API Version: Development

IPCortex.Types.History

A History instance represents a call that has ended. It will be created automatically on any Device that has had History recording enabled. If a call is seen on many devices at once, then a History record is only created when the last one ends.

Properties

Name Type Description
name String Original name/label on the sent or received Call or empty string if unavailable.
number String Orginal number on the sent or received Call or empty string if unavailable.
device Device Device instance the Call originated on.
stamp Number Start time in epoch milli-seconds.
start Number Answered time in epoch milli-seconds.
end Number Ended time in epoch milli-seconds.
remoteNumber String Number of the other party or empty string if unavailable.
remoteName String Name/label of the other party or empty string if unavailable.
callID String Unique identifer of the associated Call.
party String The party for this History entry. Used to determine the original direction of the call.
  • caller
  • callee
  • noanswer
  • missed

Methods

history.addListener(event, callback)

Kind: class method of IPCortex.Types.History
Add listener method, inherited from Api base class and common to all classes.
Parameter Type Description
event String Name of event, e.g. 'update'
callback Function Callback which is passed a reference to the updated Class object

history.removeListener(event, callback)

Kind: class method of IPCortex.Types.History
Remove listener method, inherited from Api base class and common to all classes. event and callback must be identical to those used in addListener() in order for the remove to succeed.
Parameter Type Description
event String Name of event, e.g. 'update'
callback Function Callback which is passed a reference to the updated Class object

Events

  • new - A new history is created.