Contents

CallObject

CallObject manipulates call objects (telephone calls). This object supports standard telephony operations, such as placing, muting, recording, or disconnecting a call. In addition, the CallObject supports specialized operations normally performed by the CIC client. For example, CallObject methods can be used to make a call private, or send a call to voice mail. The methods and properties supported by the CallObject are listed below. Click on a link for information concerning input parameters and return values.

Methods

CallObject.blindTransfer	Performs a blind transfer to the specified telephone number. Use a blind transfer if you do not need to speak with the recipient before transferring a call. If the intended recipient does not answer, the call is sent to the recipient's voice mail.
CallObject.consultTransfer	Performs a consult transfer. Use a consult transfer if you need to speak with the recipient before transferring the call. If the intended recipient does not answer the phone, you can resume your conversation with the caller, transfer the call to the intended recipient's voice mail, or transfer the call to another person.
CallObject.currentDialerCallId	Returns the Id of the current active dialer interaction. This can be used to set a CallObject's id to initialize it with the current active dialer call.
CallObject.dial	Dials a phone number. If you want to catch errors, use a Handler or Object Watcher to receive error codes. Using Dial is the same as calling ExtendedDial with TimeoutSecs=15 and no call analysis.
CallObject.disconnect	Disconnects the current call.
CallObject.extendedDial	Dials a number, allows for call analysis, and optionally forces a timeout within a specified timeout period.
CallObject.getAttribute	Retrieves the value of the specified call object attribute.
CallObject.hold	Places a call on hold.
CallObject.listen	Allows a CIC user to listen in on a call.
CallObject.mute	Mutes a call so the remote party cannot hear what the local (CIC) party is saying.
CallObject.pause	Pauses recording of the current call.
CallObject.pickup	Picks up (answers) a call.
CallObject.playDigits	Plays DTMF tones for the string of digits provided as an input parameter.
CallObject.private	Makes a call private so it cannot be listened to or recorded by another CIC user.
CallObject.record	Records a call.
CallObject.setAttribute	Sets the value of the specified call object attribute.
CallObject.voicemail	Sends a call to the current user's voice mail.
CallObject.pauseSecureRecord	Can be used to avoid recording sensitive information, such as a Social Security number or credit card number, when connected to a call interaction.
CallObject.resumeSecureRecord	Resumes recording that was paused by invoking the CallObject.pauseSecureRecord method.

Callbacks

CallObject.errorHandler	Is invoked by when an internal error occurs in the call object. If you pass the name of a user-defined function to CallObject.errorHandler, the function will be called when this event occurs. This callback is compatible with scripts for Scripter .NET Client or Interaction Connect.
CallObject.stateChangeHandler	Is invoked whenever the call state changes. This callback is compatible with scripts for Scripter .NET Client or Interaction Connect.
CallObject.callObjectInitializedHandler	Allows a script to dial a number after waiting asynchronously for a call object to be created. Use this callback only in scripts for Interaction Connect.

Properties

CallObject.conferenceId	Returns a conference object ID if the call is included in a conference call.
CallObject.creationTime	Returns the date and time that the call object was created.
CallObject.direction	Indicates the direction of the call (e.g. inbound, outbound, etc.).
CallObject.id	Returns or sets the unique identifier of a call object.
CallObject.isHeld	Indicates whether or not a call is on hold.
CallObject.isMonitored	Indicates whether or not a call is being listened to.
CallObject.isMuted	Indicates whether or not a call is muted.
CallObject.isParty	Indicates whether the call is included in a conference call.
CallObject.isPaused	Indicates whether recording of a call has been paused.
CallObject.isPrivate	Indicates whether is in a private state, meaning that no one can listen in on (monitor) the call.
CallObject.isRecording	Indicates whether a call is being recorded.
CallObject.lastError	Retrieves the text of the last error that occurred in the CallObject. Each time a method or property is called on the CallObject, this value is cleared.
CallObject.lastErrorId	Retrieves the id of the last error that occurred in the CallObject. Each time a method or property is called on the CallObject, this value is cleared.
CallObject.localId	Returns the Station Id associated with the call.
CallObject.localLocation	Returns the phone extension of the station participating in an inbound or outbound call.
CallObject.localName	Returns the name of the logged in user.
CallObject.remoteId	Returns the formatted telephone number of the person outside CIC who is making or receiving a call.
CallObject.remoteLocation	Returns the unformatted telephone number of the person outside CIC who is making or receiving a call.
CallObject.remoteName	Returns or sets the name of the caller.
CallObject.state	Returns the integer value corresponding to the call state of the call object.
CallObject.stateString	Retrieves or sets the string value that is displayed as call state information in the CIC client.