Click or drag to resize

Call Properties

The Call type exposes the following members.

Properties
  NameDescription
Public propertyAbbreviatedDelayedRingCycles
The ring cycles for abbreviated and delayed alerting for incoming call.
Public propertyAddCollaborationCapability
Capability object indicating whether the collaboration can be added to the call.
Public propertyAlertDelay
For an incoming call, the alert delay. Server might indicate that the client should delay playing the ringing audio for the given amount of seconds. Can vary from 0 to 30 with 0 meaning that there is no alert delay.
Public propertyAlertType
For an incoming call, the associated alert type.
Public propertyAllowedVideoDirection
Allowed video direction for the call based on its state, type and network availability.
Public propertyANI
The user part (leading plus sign is removed, e.g. "12345" for "+12345@domain" and "mary" for "mary@domain") of the remote party (caller address) of incoming call which will be used for Automatic Number Identification.
Public propertyAnswered
A Boolean value indicating whether this call ever answered
Public propertyAudioMuted
A Boolean value indicating whether audio has been explicitly muted for this call.
Public propertyCallerIdentityPrivate
A Boolean value indicating whether the identity of the user who initiated the call wishes their identity to be kept private. For an incoming call, this property returns whether the remote user's address is private. For an outgoing call, this property returns whether the local user's address is private (which can happen if user chooses to make a private call).
Public propertyCallerInformation
Caller information (maximum 16 digits) associated with the call. The collected digits information neither change during the life of the call nor it can be updated during the life of a call. In case of transfer of call caller information associated with the call is also transferred. Collected digits which are sent as part of call establishment will be provided to the sip application in a new sip header Avaya-user-data. Avaya-User-Data:45676;purpose=collected-digits;content=digits;encoding=text Example: Collect 4 digits after announcement 3502 (Thank you for calling the Widget Company. If you know your party's 4-digit extension, please dial it now or stay on the line for the operator.) An empty string is returned if call does not have digit information.
Public propertyCallId
The unique numeric ID for this call.
Public propertyCallType
A CallType enum value indicating whether this is default registered service (SIP call through Aura) or MeetMe call through ServiceGateway.
Public propertyCanAutoAnswer
A Boolean value indicating whether this incoming call can be answered automatically.
Public propertyConference
The conference instance associated with the call. The Conference object is returned regardless of whether the call is a conference call or not. Invoking methods on the Conference object returns an error if the call is not a conference call.
Public propertyDenialCapability
Capability indicating whether an incoming call can be denied.
Public propertyEndCallCapability
Capability indicating whether the call can be ended.
Public propertyEstablishedTime
Time when call got originally established.
Public propertyExtraProperties
Extra properties of the call. These properties consist of information that are not mapped to existing properties in the API. The extra properties may depend on the business logic of the network application that populate them.
Public propertyForwardingInformation
Information about forwarding details of this incoming call. Information can be null if this call was not forwarded.
Public propertyHeldTime
Time when call was last put on hold.
Public propertyHoldCapability
Capability info indicating whether the call can be held.
Public propertyIncoming
A Boolean value indicating whether this is an incoming call.
Public propertyIncomingVideoStatus
Determine if the incoming call has video.
Public propertyIsAutoAnswerEnabled
A Boolean value indicating whether this incoming call can be answered automatically.
Public propertyIsAutomaticCallDistributionCall
A Boolean value indicating whether the call is an Automatic Call Distribution (ACD) call.
Public propertyIsConference
A Boolean value indicating whether this is a conference call.
Public propertyIsEmergencyCall
A Boolean value indicating whether or not this call is an emergency call.
Public propertyIsIgnored
A Boolean value indicating whether this is an ignored call.
Public propertyIsPickupCall
Returns true if the call is created as a result of invoking the call pickup feature GroupCallPickup, DirectedCallPickup, ExtendedGroupCallPickup or Team Button pickup.
Public propertyIsPresentationOnlyMode
A Boolean value indicating whether the call is in presentation only mode.
Public propertyIsRecordingActive
A Boolean value indicating whether the call is being recorded.
Public propertyIsRecordingPaused
A Boolean value indicating whether the call recording is paused.
Public propertyIsRemoteAgentPhoneCall
A Boolean value indicating whether this incoming call is a remote agent phone call.
Public propertyIsRonaOrRoofRedirection
A Boolean value indicating whether the call was redirected by Redirection on no answer (RONA) or Redirection on Off-PBX Telephone (ROOF) Integration and Mobility (OPTIM) Failure.
Public propertyIsSecureCall
A Boolean value indicating whether the call is secure or not.
Public propertyIsServiceAvailable
A Boolean value indicating whether there is an active signaling path available for this call.
Public propertyIsServiceObserving
A Boolean value indicating whether this incoming call is a service observing connection.
Public propertyIsTeamButtonCall
Returns true if the call is created as a result of invoking the Team Button feature.
Public propertyIsVideoActive
A convenience method that returns if the call has active video session or not.
Public propertyJoinCapability
Capability info indicating whether the call can be joined.
Public propertyLineAppearanceId
The line id for the remote call.
Public propertyLineAppearanceOwnerAddress
The remote call owner address.
Public propertyLineAppearanceOwnerDisplayName
The display name of the line appearance owner for bridged line calls.
Public propertyLineAppearanceRingType
Line appearance ring type for an incoming call.
Public propertyMissed
For an incoming call, a Boolean value indicating whether the call was missed.
Public propertyMultiVideoChannelsCapability
Property providing the maximum number of receive only video streams that can be supported, and the maximum resolution that can be supported for each video stream.
Public propertyMuteCapability
Capability info indicating whether the call's audio can be muted.
Public propertyOriginalRemoteAddress
Remote number the local client/user dialed to make an outgoing call. This value represents the number prior to applying any dialing rule. Once this value is set, it is not modified even if server changes remote address.
Public propertyPrecedenceLevel
The current precedence level of call.
Public propertyPreemptionReason
The reason why this call was preempted.
Public propertyRemote
A Boolean value indicating whether this is a remote call.
Public propertyRemoteAddress
The remote address for this call.
Public propertyRemoteDialedNumber
Represents the number dialed by originator of incoming call. For outgoing calls this property is empty.
Public propertyRemoteDisplayName
The display name for the remote end of the call.
Public propertyRemoteNumber
The number for the remote end of the call. For outgoing calls, it's the post dialing rules string. For incoming SIP calls, it's the user part of the URI or URI in case of alphanumerical user part.
Public propertyRemoteParticipant
The information about the remote participant connected to the call. The information in participant can be empty if call is not connected OR the details are not available for remote party.
Public propertySendDtmfCapability
Capability info indicating whether the call can transmit DTMF tones.
Public propertySilenceSpeakerCapability
Capability info indicating whether speaker can be silenced for the call.
Public propertySpeakerSilenced
A Boolean value indicating whether speaker has been explicitly silenced for this call.
Public propertyState
The call's current state.
Public propertySubject
The subject line associated with the call, if any.
Public propertySupervisorCallType
Indicates supervisor call.
Public propertyTransferCapability
Capability info indicating whether unattended transfer can be performed on this call.
Public propertyTransferToVoicemailCapability
Capability info indicating whether the transfer to voicemail can be done.
Public propertyUnholdCapability
Capability info indicating whether the call can be unheld.
Public propertyUnmuteCapability
Capability info indicating whether the call's audio can be unmuted.
Public propertyUnsilenceSpeakerCapability
Capability info indicating whether speaker can be unsilenced for the call.
Public propertyUpdateVideoModeCapability
Capability info indicating whether video can be updated based on the current state and capabilities of the call.
Public propertyUserToUserInformation
User-to-User Information (UUI) associated with the call. UserToUserInformation
Public propertyVectorDirectoryNumberName
Represents a Vector Directory Number (VDN) name. Agent may need to know which VDN the call has arrived from in order to get prepared. For example, agent may consult for sales and for technical support questions. And voice menu have the VDNs for sales and technical support. Once call is ringing, agent can see the VDN name and get prepared to talk on the particular subject.
Public propertyVerificationStatus
Returns an enumeration value indicating the verification status for an incoming call.
Public propertyVideoChannels
Get the video channels set on the call.
Public propertyVideoMode
Current video mode set for the call.
Top
See Also