Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
Call Class
Call Properties
Call Methods
Call Events

# Call Class

The Call class is a facade object that may be used to represent a 2-party or conference call. When a Call instance represents a 2-party call, conference-related methods are unsupported. The client application can use Conference property regardless of whether the call is a point to point or a conference call. Calling conference operations on a normal point to point call returns failure. The Call also supports video control methods, which can be applied to either a 2-party or a conference call.
Inheritance Hierarchy
System
Object
Avaya.ClientServices
Call

Namespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntax
C#
Copy

    public class Call

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
Methods

| Name | Description
--- | --- | ---
| Accept | For an incoming call, Requests acceptance of an incoming call.
| AcceptVideo | Accepts an incoming video request to add video to the call.
| AddCollaboration | Adding a collaboration session to the active call. This method is to bring the call to the correct state for triggering the auto-creation collaboration feature. If the call is a P2P call and the collaboration service requires the call to be a conference, the P2P call will be escalated to the conference. If the call is already a conference, then this method will not do anything.
| AddRemoteAddressDigit | For a call in the off-hook dialing state, adds a digit to the remote address being collected via a dial pad.
| Deny(Call CallCompletionHandler) | For an incoming call, denies the call using appropriate reason based on SipUserConfiguration.CallDenialPolicy configuration property. The default denial reason is busy.
| Deny(DenialReason, Call CallCompletionHandler) | For an incoming call, denies the call for the specified reason regardless of the configured SipUserConfiguration.CallDenialPolicy property.
| DenyVideo | Denies an incoming video request to add video to the call.
| End | Requests termination of the call.
| GetTransferToCapability | Capability info indicating whether the call can be transferred to target call.
| Hold | Requests that an active call be held.
| Ignore | For an incoming call, ignores the call.
| Join | For a remote call, joins the call.
| MuteAudio | Mutes or unmutes the call's audio.
| ReadAudioDetails | Returns detailed information about the audio channel associated with the call.
| ReadVideoDetails | Returns detailed information about all video channels associated with the call.
| SendDtmf | Sends the specified DTMF tone.
| SetReceiveVideoResolutionPreferences | Used in conjunction with SetVideoMode(VideoMode, Call CallCompletionHandler) to set receive video resolutions the client application wants to have for multi video stream calls. Calling this method is optional.
| SetVideoMode | Set the video mode for the call.
| SetVideoResolutionPreference | Used in conjunction with SetVideoMode(VideoMode, Call CallCompletionHandler) to set video resolution. The actual resolution can be lower than the specified preference. It is subjected to negotiation result, configuration limits, and/or hardware capability. Calling this method is optional. This method may be called mid-call. Note: This API adjusts the encoder and decoder resolution. It does not affect the video capture resolution. Refer to the media engine documentation to adjust the video capture resolution.
| SilenceSpeaker | Silences or unsilences speaker for the call.
| Start | Starts an outgoing call to the current remote address.
| Transfer(String, Call TransferStatusHandler) | Transfers this call to the specified remote address (an unattended transfer).
| Transfer(Call, Call TransferStatusHandler) | Transfers this call to another call (an attended transfer).
| Transfer(String, Boolean, Call TransferStatusHandler) | Transfers this call to the specified remote address (an unattended transfer).
| TransferToVoicemail(String, Call TransferStatusHandler) | Transfers this call to the specified remote address's voicemail (an unattended transfer).
| TransferToVoicemail(String, Boolean, Call TransferStatusHandler) | Transfers this call to the specified remote address's voicemail (an unattended transfer).
| Unhold | Requests that a held call be unheld.

Top
Events

| Name | Description
--- | --- | ---
| AgentGreetingRequested | Occurs when a new Automatic Call Distribution (ACD) call is presented to the Agent endpoint and the application should play an appropriate greeting.
| AllowedVideoDirectionChanged | Occurs when the allowed video direction has changed.
| AudioMuteStatusChanged | Occurs when the call's audio is muted or unmuted.
| CallRecordingStateChanged | Occurs when the call recording state has changed.
| CallSecureIndicationChanged | Occurs when the security indication of the call changes.
| CallVerificationStatusChanged | Occurs when the call verification status has changed.
| CapabilitiesChanged | Occurs when the call's capabilities change, e.g., as a result of call state change or an internal event.
| ConferenceDetailsChanged | Occurs when the conference details for the call have changed.
| ConferenceStatusChanged | Occurs when the conference status of the call has changed.
| Denied | Occurs when the incoming call has been successfully denied.
| DigitCollectionCompleted | For a call in the off-hook dialing state, indicates that digit collection has completed and the call will now be initiated using the collected digits.
| DigitCollectionPlayDialTone | For a call in the off-hook dialing state, indicates that the dial plan data has specified that the application should resume playing dial tone until another digit is entered.
| Ended | Occurs when the call has ended.
| Established | Occurs when the outgoing call has been established.
| ExtraPropertiesChanged | Occurs when the extra properties associated with the call has changed.
| Failed | Occurs when the call has failed.
| Held | Occurs when the call has been held.
| HeldRemotely | Occurs when the call has been held on the remote end.
| Ignored | Occurs when an incoming call is ignored, as a result of a call.
| IncomingVideoAddRequestAccepted | Occurs when an incoming video add request has been accepted by the local end.
| IncomingVideoAddRequestDenied | Occurs when an incoming video add request has been denied by the local end.
| IncomingVideoAddRequestReceived | Occurs when the remote end has requested that video to be added to the call.
| IncomingVideoAddRequestTimedOut | Occurs when an incoming video add request has timed out.
| Joined | Occurs when the call has been successfully joined and transitioned from a remote call to a local call.
| LongHoldTimeExpired | Sent when the call was kept on hold for longer than the hold recall timeout administered on Avaya Communication Manager (CM). Upon receipt of this event, the SDK's client application is responsible for presenting (alerting) the event to the user.
| ParticipantMatchedContactsChanged | Occurs when participant's matched contact changed.
| PrecedenceLevelChanged | Occurs when the precedence level for the call has changed.
| Preempted | Occurs when the call is preempted.
| Queued | Occurs when an outgoing call is queued by a network server.
| Redirected | Occurs when an outgoing call is redirected by the network servers to a different destination (e.g., when EC500 forking takes place or a call is covered to voicemail).
| RemoteAddressChanged | Occurs when the remote address or display name for the call has changed.
| RemoteAlerting | Occurs when the outgoing call begins alerting at the remote end.
| RemoteControlVideoModeRequested | Occurs when the application is informed of a video mode change request received from the user's other endpoint which is controlling this application instance in Shared Control mode (see EnableAsControlledEndpoint).
| ServiceAvailable | Occurs when a signaling path has been established for the call.
| ServiceUnavailable | Occurs when the signaling path for the call has been lost.
| SpeakerSilenceStatusChanged | Occurs when speaker is silenced or unsilenced for the call.
| Started | Occurs when the call has been started.
| Transferred | Occurs when an outgoing transfer operation is successful.
| Unheld | Occurs when the call has been unheld.
| UnheldRemotely | Occurs when the call has been unheld on the remote end.
| VideoChannelsUpdated | Occurs when video channels have been updated. This event is reported after a video operation such as initiate an outgoing video call, block/unblock video, accept incoming video request, etc.

Top
See Also

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.