Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
Call Class
Call Properties
AbbreviatedDelayedRingCycles Property
AddCollaborationCapability Property
AlertDelay Property
AlertType Property
AllowedVideoDirection Property
ANI Property
Answered Property
AudioMuted Property
CallerIdentityPrivate Property
CallerInformation Property
CallId Property
CallType Property
CanAutoAnswer Property
Conference Property
DenialCapability Property
EndCallCapability Property
EstablishedTime Property
ExtraProperties Property
ForwardingInformation Property
HeldTime Property
HoldCapability Property
Incoming Property
IncomingVideoStatus Property
IsAutoAnswerEnabled Property
IsAutomaticCallDistributionCall Property
IsConference Property
IsEmergencyCall Property
IsIgnored Property
IsPickupCall Property
IsPresentationOnlyMode Property
IsRecordingActive Property
IsRecordingPaused Property
IsRemoteAgentPhoneCall Property
IsRonaOrRoofRedirection Property
IsSecureCall Property
IsServiceAvailable Property
IsServiceObserving Property
IsTeamButtonCall Property
IsVideoActive Property
JoinCapability Property
LineAppearanceId Property
LineAppearanceOwnerAddress Property
LineAppearanceOwnerDisplayName Property
LineAppearanceRingType Property
Missed Property
MultiVideoChannelsCapability Property
MuteCapability Property
OriginalRemoteAddress Property
PrecedenceLevel Property
PreemptionReason Property
Remote Property
RemoteAddress Property
RemoteDialedNumber Property
RemoteDisplayName Property
RemoteNumber Property
RemoteParticipant Property
SendDtmfCapability Property
SilenceSpeakerCapability Property
SpeakerSilenced Property
State Property
Subject Property
SupervisorCallType Property
TransferCapability Property
TransferToVoicemailCapability Property
UnholdCapability Property
UnmuteCapability Property
UnsilenceSpeakerCapability Property
UpdateVideoModeCapability Property
UserToUserInformation Property
VectorDirectoryNumberName Property
VerificationStatus Property
VideoChannels Property
VideoMode Property

Call Properties

The Call type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AbbreviatedDelayedRingCycles | The ring cycles for abbreviated and delayed alerting for incoming call.
| AddCollaborationCapability | Capability object indicating whether the collaboration can be added to the call.
| AlertDelay | 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.
| AlertType | For an incoming call, the associated alert type.
| AllowedVideoDirection | Allowed video direction for the call based on its state, type and network availability.
| ANI | 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.
| Answered | A Boolean value indicating whether this call ever answered
| AudioMuted | A Boolean value indicating whether audio has been explicitly muted for this call.
| CallerIdentityPrivate | 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).
| CallerInformation | 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.
| CallId | The unique numeric ID for this call.
| CallType | A CallType enum value indicating whether this is default registered service (SIP call through Aura) or MeetMe call through ServiceGateway.
| CanAutoAnswer | A Boolean value indicating whether this incoming call can be answered automatically.
| Conference | 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.
| DenialCapability | Capability indicating whether an incoming call can be denied.
| EndCallCapability | Capability indicating whether the call can be ended.
| EstablishedTime | Time when call got originally established.
| ExtraProperties | 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.
| ForwardingInformation | Information about forwarding details of this incoming call. Information can be null if this call was not forwarded.
| HeldTime | Time when call was last put on hold.
| HoldCapability | Capability info indicating whether the call can be held.
| Incoming | A Boolean value indicating whether this is an incoming call.
| IncomingVideoStatus | Determine if the incoming call has video.
| IsAutoAnswerEnabled | A Boolean value indicating whether this incoming call can be answered automatically.
| IsAutomaticCallDistributionCall | A Boolean value indicating whether the call is an Automatic Call Distribution (ACD) call.
| IsConference | A Boolean value indicating whether this is a conference call.
| IsEmergencyCall | A Boolean value indicating whether or not this call is an emergency call.
| IsIgnored | A Boolean value indicating whether this is an ignored call.
| IsPickupCall | Returns true if the call is created as a result of invoking the call pickup feature GroupCallPickup, DirectedCallPickup, ExtendedGroupCallPickup or Team Button pickup.
| IsPresentationOnlyMode | A Boolean value indicating whether the call is in presentation only mode.
| IsRecordingActive | A Boolean value indicating whether the call is being recorded.
| IsRecordingPaused | A Boolean value indicating whether the call recording is paused.
| IsRemoteAgentPhoneCall | A Boolean value indicating whether this incoming call is a remote agent phone call.
| IsRonaOrRoofRedirection | 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.
| IsSecureCall | A Boolean value indicating whether the call is secure or not.
| IsServiceAvailable | A Boolean value indicating whether there is an active signaling path available for this call.
| IsServiceObserving | A Boolean value indicating whether this incoming call is a service observing connection.
| IsTeamButtonCall | Returns true if the call is created as a result of invoking the Team Button feature.
| IsVideoActive | A convenience method that returns if the call has active video session or not.
| JoinCapability | Capability info indicating whether the call can be joined.
| LineAppearanceId | The line id for the remote call.
| LineAppearanceOwnerAddress | The remote call owner address.
| LineAppearanceOwnerDisplayName | The display name of the line appearance owner for bridged line calls.
| LineAppearanceRingType | Line appearance ring type for an incoming call.
| Missed | For an incoming call, a Boolean value indicating whether the call was missed.
| MultiVideoChannelsCapability | 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.
| MuteCapability | Capability info indicating whether the call's audio can be muted.
| OriginalRemoteAddress | 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.
| PrecedenceLevel | The current precedence level of call.
| PreemptionReason | The reason why this call was preempted.
| Remote | A Boolean value indicating whether this is a remote call.
| RemoteAddress | The remote address for this call.
| RemoteDialedNumber | Represents the number dialed by originator of incoming call. For outgoing calls this property is empty.
| RemoteDisplayName | The display name for the remote end of the call.
| RemoteNumber | 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.
| RemoteParticipant | 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.
| SendDtmfCapability | Capability info indicating whether the call can transmit DTMF tones.
| SilenceSpeakerCapability | Capability info indicating whether speaker can be silenced for the call.
| SpeakerSilenced | A Boolean value indicating whether speaker has been explicitly silenced for this call.
| State | The call's current state.
| Subject | The subject line associated with the call, if any.
| SupervisorCallType | Indicates supervisor call.
| TransferCapability | Capability info indicating whether unattended transfer can be performed on this call.
| TransferToVoicemailCapability | Capability info indicating whether the transfer to voicemail can be done.
| UnholdCapability | Capability info indicating whether the call can be unheld.
| UnmuteCapability | Capability info indicating whether the call's audio can be unmuted.
| UnsilenceSpeakerCapability | Capability info indicating whether speaker can be unsilenced for the call.
| UpdateVideoModeCapability | Capability info indicating whether video can be updated based on the current state and capabilities of the call.
| UserToUserInformation | User-to-User Information (UUI) associated with the call. UserToUserInformation
| VectorDirectoryNumberName | 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.
| VerificationStatus | Returns an enumeration value indicating the verification status for an incoming call.
| VideoChannels | Get the video channels set on the call.
| VideoMode | Current video mode set for the call.

Top
See Also

#### Reference

Call Class
Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.