- Contents
Interaction Scripter Developer's Guide
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
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. |
|
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. |
|
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. |
|
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. |
|
Disconnects the current call. |
|
Dials a number, allows for call analysis, and optionally forces a timeout within a specified timeout period. |
|
Retrieves the value of the specified call object attribute. |
|
Places a call on hold. |
|
Allows a CIC user to listen in on a call. |
|
Mutes a call so the remote party cannot hear what the local (CIC) party is saying. |
|
Pauses recording of the current call. |
|
Picks up (answers) a call. |
|
Plays DTMF tones for the string of digits provided as an input parameter. |
|
Makes a call private so it cannot be listened to or recorded by another CIC user. |
|
Records a call. |
|
Sets the value of the specified call object attribute. |
|
Sends a call to the current user's voice mail. |
|
Can be used to avoid recording sensitive information, such as a Social Security number or credit card number, when connected to a call interaction. |
|
Resumes recording that was paused by invoking the CallObject.pauseSecureRecord method. |
Callbacks
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. |
|
Is invoked whenever the call state changes. This callback is compatible with scripts for Scripter .NET Client or Interaction Connect. |
|
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
Returns a conference object ID if the call is included in a conference call. |
|
Returns the date and time that the call object was created. |
|
Indicates the direction of the call (e.g. inbound, outbound, etc.). |
|
Returns or sets the unique identifier of a call object. |
|
Indicates whether or not a call is on hold. |
|
Indicates whether or not a call is being listened to. |
|
Indicates whether or not a call is muted. |
|
Indicates whether the call is included in a conference call. |
|
Indicates whether recording of a call has been paused. |
|
Indicates whether is in a private state, meaning that no one can listen in on (monitor) the call. |
|
Indicates whether a call is being recorded. |
|
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. |
|
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. |
|
Returns the Station Id associated with the call. |
|
Returns the phone extension of the station participating in an inbound or outbound call. |
|
Returns the name of the logged in user. |
|
Returns the formatted telephone number of the person outside CIC who is making or receiving a call. |
|
Returns the unformatted telephone number of the person outside CIC who is making or receiving a call. |
|
Returns or sets the name of the caller. |
|
Returns the integer value corresponding to the call state of the call object. |
|
Retrieves or sets the string value that is displayed as call state information in the CIC client. |