Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
AgentService Class
AgentService Methods
AddSkill Method
CallSupervisor Method
ConsultSupervisor Method
ExitViewStatistics Method
GetCallSupervisorCapability Method
GetConsultSupervisorCapability Method
IsAgentFeatureAvailable Method
IsAgentWorkModeAllowed Method
Login Method
Logout Method
QueueStatisticsMonitoringCapability Method
RefreshAllViewStatistics Method
RemoveSkill Method
SendCallWorkCode Method
SetAgentWorkMode Method
SetLabelForAgentFeature Method
SetOverrideForcedLogout Method
SetQueueStatisticsRefreshInterval Method
SetViewStatisticsRefreshInterval Method
StartQueueStatisticsMonitoring Method
StopQueueStatisticsMonitoring Method
ViewStatistics Method

# AgentService Methods

The AgentService type exposes the following members.

Methods

| Name | Description
--- | --- | ---
| AddSkill | Request to add a skill to the skills assigned to an agent.
| CallSupervisor | Requests for supervisor assistance based on skill.
| ConsultSupervisor | Requests for supervisor assistance based on active call.
| ExitViewStatistics | Clear the ViewStatistics(Int32, String, AgentService AgentServiceCompletionHandler) display preference. The requested statistics entity is not considered active anymore.
| GetCallSupervisorCapability | Returns an indication as to whether the supervisor assistance is available based on skill.
| GetConsultSupervisorCapability | Returns an indication as to whether the supervisor assistance is available for active call.
| IsAgentFeatureAvailable | Returns whether a specific agent feature is available or not.
| IsAgentWorkModeAllowed | Returns an indication as to whether the agent work mode indicated by eAgentWorkMode is allowed for use.
| Login | Starts agent login process with the signalling servers.
| Logout | Starts agent logout process with the signalling servers. Use '0' as default reason code if reason code is not available.
| QueueStatisticsMonitoringCapability | Returns an indication whether queue statistics monitoring feature is available for particular skill or not.
| RefreshAllViewStatistics | Refresh all active ViewStatistics(Int32, String, AgentService AgentServiceCompletionHandler) entities. View statistics entity counts as active if it was requested via ViewStatistics(Int32, String, AgentService AgentServiceCompletionHandler) and no ExitViewStatistics(Int32, AgentService AgentServiceCompletionHandler) was called on it afterwards. This action is not available if SetViewStatisticsRefreshInterval(Int32, AgentService AgentServiceCompletionHandler) is set to non-zero.
| RemoveSkill | Request to remove (unassign) a skill that is assigned to an agent.
| SendCallWorkCode | Sends the specified call work code.
| SetAgentWorkMode | Sets agent work mode. The updated work mode is notified via AgentWorkModeChanged event.
| SetLabelForAgentFeature | Updates agent feature with a personalized label given by user.
| SetOverrideForcedLogout | Enables or disables agent's logout override operation. The signalling server configuration allows it to forcefully logout an agent after a pre-configured time duration. The agent has the capability to override the forced logout operation by using this method.
| SetQueueStatisticsRefreshInterval | Sets refresh interval for queue statistics.
| SetViewStatisticsRefreshInterval | Set the refresh interval for ViewStatistics(Int32, String, AgentService AgentServiceCompletionHandler). Active statistics entities will be requested periodically once in the given amount of seconds.
| StartQueueStatisticsMonitoring | Starts queue statistics monitoring. It provides information about particular skill or queue for the agent as administered on signalling server.
| StopQueueStatisticsMonitoring | Stops queue statistics monitoring operation.
| ViewStatistics | Request display of the statistics for agents, splits or skills, VDNs and trunk groups in accordance to the VuStats button configuration. The statistics reflect information collected during the configured interval, since the agent logged in, since the day began, or historical data accumulated over an administered number of intervals. The information is limited to 40 characters displayed at a time. Statistics request can provide information to display on demand or update it periodically depending on the server settings for the given statistics type. The requested statistics entity is considered active.

Top
See Also

#### Reference

AgentService Class
Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.