ININ csCommands

See Using Commands in a Script and Page Controls for more information.

There is a common structure to all csCommands: csCommand ('[command]','[param1]','[param2]','[param3],'[param4]');

where:

[command]: the command chosen from the list below

[param1] : depending on command it may require this option, see individual csCommand specification

[param2] : depending on command it may require this option, see individual csCommand specification

[param3] : depending on command it may require this option, see individual csCommand specification

[param4] : depending on command it may require this option, see individual csCommand specification

In some instances more than one command is listed, this is mainly due to old (but still functioning) csCommands being referenced in some instances.

Where the command has further functionality (arguments) hyperlinks are provided:

ININ cs Command	Description	Example
closecall	Disconnects Interaction, closes the current script and returns user to Agent Desktop.	csCommand('closecall');
completeconsulttransfer	Completes a consult transfer if one has been started. Optionally transfer script.	Follow command hyperlink for more information
conference	Adds connected party to a conference call.	Follow command hyperlink for more information
disconnect	Disconnects the current Interaction from the user queue.	csCommand('disconnect');
disabledisconnectonscriptcomplete	Temporary override of the global application setting "CTCallDisconnectOnClose" (which is in the Application Settings/CTI section) affecting only the current Interaction. When set to 'True' this setting will cause the application to keep the the active interaction connected upon script close. When set to 'False' the Interaction will be disconnected. The temporary effect of using this command will cease returning to system default when the current interaction is disconnected.	csCommand('disabledisconnectonscriptcomplete','True'); csCommand('disabledisconnectonscriptcomplete','False');
endbreak	The endbreak command will allow any pending dialler break requests to be cancelled. If the user is already in a granted break the command will end break and return them into available ready for the next dialler call.	csCommand('endbreak')
executehandler	This fires a custom notification, which in turn can invoke a handler.	Follow command hyperlink for more information
getattribute	Returns the string value of the specified CIC Attribute.	Follow command hyperlink for more information
getdialerattribute	Returns the string value of the specified Dialer Attribute.	csCommand('getdialerattribute',{attributename});
currentobjid currentobjidstring getcallid getcallidkey getcallidstring	All listed commands serve same purpose: Returns the Interaction ID of the active Interaction. If no Interaction exists it returns '-1'. (see "getcallidkey also)	csCommand('currentobjid'); csCommand('currentobjidstring'); csCommand('getcallid'); csCommand('getcallidkey'); csCommand('getcallidstring');
currentconsultidstring getconsultcallid getconsultcallidstring	All listed commands serve same purpose: Returns the Interaction ID of the active consult call. If no Interaction ID exists it returns '-1'.	csCommand('currentconsultidstring'); csCommand('getconsultcallidstring'); csCommand('getconsultcallid');
getstationname	Gets the logged in Station name.	csCommand('getstationname');
getstatus getstatuskey	All listed commands serve the same purpose: Returns the current user status.	csCommand('getstatus'); csCommand('getstatuskey');
getuserid	Gets the Agent's Interaction Login ID.	csCommand('getuserid');
hold	Places the current CIC Object on Hold. It returns '1' if Object.IsHeld is true, or '0' if Object.IsHeld is false. See unhold.	csCommand('hold');
isheld	Indicates whether the current call is on hold. It returns '1' if the current call is held, or '0' if the current call is not held.	csCommand('isheld');
ismuted	Indicates whether the current call is muted. It returns '1' if the current call is muted, or '0' if the current call is not muted.	csCommand('ismuted');
ispaused	Indicates whether the current call is paused. It returns '1' if the current call is paused, or '0' if the current call is not paused.	csCommand('ispaused');
isprivate	Indicates whether the current call is private. It returns '1' if the current call is private, or '0' if the current call is not private.	csCommand('isprivate');
isrecording	Indicates whether the current call is being recorded. It returns '1' if the current call is recording, or '0' if the current call is not recording.	csCommand('isrecording');
isuserrecording	Indicates whether the current call is being manually recorded by a user. It returns '1' if the current call is being manually recorded by a user, or '0' if the current call is not being manually recorded by a user.	csCommand('isuserrecording');
logerror	Will display a 'Toast' Error message popup with a custom error message and add an ERROR level entry to the CT log .^* Potentially useful for those developing custom controls	Follow command hyperlink for more info
loghigh	Will display a 'Toast' Error message popup with a custom error message and add a FATAL level entry to the CT log .^* This might be used in custom controls for logging purposes.	Follow command hyperlink for more info
loglow	Will add a DEBUG level entry to the CT log .^* This might be used in custom controls for logging purposes.	Follow command hyperlink for more info
logmed	Will add an INFO level entry to the CT log .^* This might be used in custom controls for logging purposes.	Follow command hyperlink for more info
logout	Requests to log the agent out of CallScripter or out of the Dialer Campaign, depending upon the value of the optional argument passed.	Follow command hyperlink for more info
logwarning	Will display a 'Toast' Warning message popup with a custom message and add a WARN level entry to the CT log .^* This might be used in custom controls for logging purposes.	Follow command hyperlink for more info
makecall makescriptcall	Places a call to the number specified in Argument 1.	Follow command hyperlink for more info
mute	Places the current Interaction on Mute. The return value is '1' if Object.IsMuted is true. Returns '0' if Object.IsMuted is false. See unmute.	csCommand('mute');
pauserec pauserecording	Toggles the recording of the current Interaction.	csCommand('pauserec'); csCommand('pauserecording');
pickup	Picks up an offering Interaction.	csCommand('pickup');
placepreviewcall	Places the call for a Preview Campaign. Returns '1' if the preview call has been placed, or '0' if the preview call has not been placed.	csCommand('placepreviewcall');
playaudiofile	Plays an audio file into the connected voice Interaction. Param 1 – playaudiofile param 2 - path to file or server filename if already present on CIC server param 3 - false if local file, true if already present on CIC server.	csCommand('playaudiofile',[FileName],'false');
private	Changes the state of the call to private	csCommand('private'); Use of the Private feature may be subject to your company's policies and should only be used in accordance with those policies. IC handler customization can be used to track the use of the Private feature to ensure compliance with such policies
record	Activates Record on the current Interaction It returns '1' if Recording is active, or '0' if Recording is not active.	csCommand('record');
removeparty	Removes a party from the conference call based on the consult call ID.	csCommand('removeparty','{callid});
requestbreak	Request a break when on a Dialer campaign.	csCommand('requestbreak','breakreason');
rescheduleagent rescheduleobagent	Sets the Interaction to be an Agent owned callback.	Follow command hyperlink for more info
rescheduledate rescheduleobdate	Sets the Reschedule Date of an Interaction to the value of Argument 1.	Follow command hyperlink for more info
rescheduledatetime	Sets the Reschedule Date of an Interaction to the value of Argument 1	Follow command hyperlink for more info
rescheduletime rescheduleobtime	Sets the Reschedule Time of an CIC object to the value of Argument 1.	Follow command hyperlink for more info
resume	Resume recording the current Interaction.	csCommand('resume');
securepause ^{(deprecated 4.5.42+)} securepausedefault (replaces securepause command to remove ambiguity with new securepause methods)	This will stop the call recording on the server with the default timeout specified on the server, as specified here : Interaction Recorder > Configuration > Recording Processing > Secure Recording Pause Duration	csCommand('SecurePause'); csCommand('SecurePauseDefault');
securepauseinfinite	This will stop the call recording on the server for the current Interaction indefinitely until "securepauseresume" csCommand is fired	csCommand('SecurePauseInfinite');
securepauseresume	This will resume the call recording on the server regardless	csCommand('SecurePauseResume');
securepausetimeout	This will stop the call recording on the server a specified number of seconds as passed through in argument 3	csCommand('SecurePauseTimeout','',[seconds]);
senddtmf	Plays DTMF digits of Argument 1 on the current Interaction	Follow command hyperlink for more info
setattribute	Sets the Interaction Attribute, specified in Argument 1 with the value of Argument 2.	Follow command hyperlink for more info
setdialerattribute	Sets the dialer interaction attribute, specified in Argument 1 with the value of Argument 2.	Follow command hyperlink for more info
setoutcome	Set the dialer category and wrap up code for the current interaction.	Follow command hyperlink for more info
setstage	Updates the stage on the Dialer.	Follow command hyperlink for more info
setstatus	Sets the user's status to the value of Argument 1.	Follow command hyperlink for more info
skippreviewcall	Marks the preview call as skipped. Only allowed if the preview call has not been placed	csCommand('skippreviewcall');
speakboth	Allows a consult call to be controlled from script content. Command will only work whilst original caller and consult call are in a connected state. When invoked it will allow the user to speak to both parties on the call without creating a conference scenario.	csCommand('speakboth');
speakcaller	When in a consult call scenario this command will allow the user to put the consult call on hold and speak to the original caller.	csCommand('speakcaller');
speakconsult	When in a consult call scenario this command will allow the user to put the consult call on hold and speak to the consulted party.	csCommand('speakconsult');
stoprecord	Stops Recording the current Interaction Will return '1' if recording stops, or '0' if recording is running.	csCommand('toprecord');
toast	Allows a toast to be presented on screen with customised header and body information.	Follow command hyperlink for more info
togglecalls	Toggles between main Interaction and a Consult Call during a transfer process	csCommand('togglecalls');
togglehold	Toggles the Hold state of the current Interaction. It returns '1' if Object.IsHeld is false, or '0' if Object.IsHeld is true.	csCommand('togglehold');
togglemute	Toggles the Mute state of the current Interaction. It returns '1' if Object.IsMuted is false, or '0' if Object.IsMuted is true.	csCommand('togglemute');
toggleprivate	Toggles the Private state of the current Interaction.	csCommand('toggleprivate');
togglerecord	Toggles the Record state of the current Interaction. It returns '1' if the state was successfully toggled, or '0' if the state was not toggled.	csCommand('togglerecord');
transfer	Starts a consult call, and optionally transfers the script if the consult call is completed.	Follow command hyperlink for more info
transferblind	Performs a blind transfer to the number specified. Options control if the script is also transferred or the Transfer Call window is displayed.	Follow command hyperlink for more info
transfercancel	Terminates a current transfer and returns to the main Interaction.	csCommand('transfercancel');
transfertofinishing	Transfers the script and call to a Finishing Workgroup Queue.	Follow command hyperlink for more info
unhold	Retrieves the current Interaction from Hold. It returns '1' if on hold or '0' if not. Also see the cscommand : "hold".	csCommand('unhold');
unmute	Un-mutes the current Interaction. It returns '1' if Object.IsMuted is false or '0' if Object.IsMuted is true. See mute.	csCommand('unmute');
userid	Gets the Agents IC Login username.	csCommand('userid');

^*CallScripter generates CTI logs at the client, (not server side). Logs are generated to text files in the following location: %localappdata%\CallScripter\CommunicationToolbar on the client PC.

The logging threshold is configured in this key : <level value="ERROR"/>, in this file : "CallScripter.CTI.Management.dll.config", Usually found in this folder : "C:\Program Files (x86)\CallScripter\CallScripter CT Providers".

Restart the CallScripter application at the client if changes have been made to the client configuration. This enables the changes to take effect.

CallScripter 4.5.53 for Interactive Intelligence

ININ csCommands

The contents of ININ csCommands