Siebel CTI Administration Guide > Siebel Communications Server Business Services >

Communications Client Methods


This topic describes the methods and method arguments of the business service Communications Client. For more information about the role of business services and methods in communications toolbar configuration, see About Communications Toolbar Configuration.

The Communications Client business service is an aggregate business service that is built on top of the Communications Session Manager service. This means that you can invoke all the methods of the Communications Session Manager service as though they were methods of the Communications Client business service.

This topic primarily uses the display names for each method (Method Display Name). The internal names, which must be used in any scripts that invoke these methods, are also shown (Method Name).

Table 61 lists the methods for the Communications Client business service.

Table 61. Communications Client Methods
Method Display Name
Method Name
Comment

Agent Sign Off

AgentSignOff

Execute logout command

Agent Sign On

AgentSignOn

Execute login command

Get Selected Work Item Info

GetSelectedWorkItemInfo

Retrieve complete work item information of the selected work item on toolbar

Handle Error

HandleError

Push error information to the agent's communications toolbar

Is Comm Enabled

IsCommEnabled

Indicates whether communications are enabled

Make Call

MakeCall

Make a phone call

Obtain UI Focus

ObtainUIFocus

Bring the browser to the front (to gain user interface focus)

Reset Active Session Count

ResetActiveSessionCount

Reset the active session count.

Send Communication

SendCommunication

Send outbound communication item

Shell UI Update

ShellUIUpdate

Update or refresh the status of the communications toolbar

Show Status Text

ShowStatusText

Push error information to the agent's communications toolbar and display message on the browser's status bar

Work Item Released

WorkItemReleased

Notification of work item released

Work Item Resumed

WorkItemResumed

Notification of work item resumed

Work Item Started

WorkItemStarted

Notification of work item started

Work Item Suspended

WorkItemSuspended

Notification of work item suspended

Siebel CTI Administration Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.