Class: PhoneCall

PhoneCall(param)

Class representing a PhoneCall (PSTN or WebRTC).

Constructor

new PhoneCall(param)

Create a PhoneCall.
Parameters:
Name Type Description
param object
Properties
Name Type Attributes Description
callId string <optional>
The unique callId. This is a required parameter
connectionId string <optional>
optional connectionID representing a call leg.
callType CALL_TYPE <optional>
The type of the call, one of the CALL_TYPE values
callSubtype CALL_SUBTYPE <optional>
The subtype of the call, one of the CALL_SUBTYPE values
contact Contact <optional>
The Call Target / Contact . TODO: to be deprecated, replace with toContact
state string <optional>
The state of the call, i.e. ringing, connected, declined, failed
callAttributes PhoneCallAttributes <optional>
Any additional call attributes
phoneNumber string <optional>
The phone number associated with this call (usually external number)
callInfo CallInfo <optional>
reason string <optional>
closeCallOnError boolean <optional>
agentStatus string <optional>
agentARN string <optional>
fromContact Contact <optional>
This is optional, and being populated when dialing/consulting a contact or adding a participant
toContact Contact <optional>
This is currently the same as param.contact (just rename)
Source:

Classes

PhoneCall