Added force_fronter_leave_3way Agent API function

git-svn-id: svn://192.168.202.10@3026 3d104415-ff17-0410-8863-d5cf3c621b8a

docs/AGENT_API.txt

@@ -1,4 +1,4 @@
-AGENT API DOCUMENT		Started: 2008-07-03	Updated: 2018-03-23
+AGENT API DOCUMENT		Started: 2008-07-03	Updated: 2018-09-08
 
 This document describes the functions of an API(Application Programming Interface)
 for the VICIDIAL Agent screen. This functionality will be rather limited at first
@@ -35,6 +35,7 @@ pause_code - set a pause code if the agent is paused
 audio_playback - basic play/pause/resume/stop/restart audio in agent session
 switch_lead - for inbound calls, switches lead_id of live inbound call on agent screen
 calls_in_queue_count - display a count of the calls waiting in queue for the specific agent
+force_fronter_leave_3way - will send a command to fronter agent to leave-3way call that executing agent is on
 
 
 New scripts:
@@ -912,6 +913,36 @@ SUCCESS: calls_in_queue_count - 0
 
 
 
+--------------------------------------------------------------------------------
+force_fronter_leave_3way - 
+
+DESCRIPTION:
+will send a command to fronter agent to leave-3way call that executing agent is on. Will not execute command for the named 'agent_user', but will look for oldest other user currently on a call with the same lead_id that the named agent_user is on the phone with.
+
+VALUES:
+ value - 
+  REQUIRED, choices are below:
+   LOCAL_ONLY - looks for fronter only on local cluster
+   LOCAL_AND_CCC - looks on local cluster and remote CCC to send command to (will always check local first)
+   CCC_REMOTE - use this when the closer is not on this cluster
+  lead_id - 
+    OPTIONAL, only to be used with CCC_REMOTE value commands
+
+EXAMPLE URLS:
+http://server/agc/api.php?source=test&user=6666&pass=1234&agent_user=1000&function=force_fronter_leave_3way&value=LOCAL_ONLY
+http://server/agc/api.php?source=test&user=6666&pass=1234&agent_user=1000&function=force_fronter_leave_3way&value=LOCAL_AND_CCC
+
+RESPONSES:
+ERROR: no user found - 6666
+ERROR: agent_user is not logged in - 6666
+ERROR: agent_user is not on a phone call - 6666
+ERROR: no fronter found - 6666
+SUCCESS: force_fronter_leave_3way SENT - 6667
+SUCCESS: force_fronter_leave_3way command sent over CCC - test_ccc
+
+
+
+
 
 --------------------------------------------------------------------------------
 Other information:

docs/CROSS_CLUSTER_COMMUNICATION.txt

@@ -1,4 +1,4 @@
-CROSS-CLUSTER COMMUNICATION	Started: 2011-05-27	Updated: 2017-08-09
+CROSS-CLUSTER COMMUNICATION	Started: 2011-05-27	Updated: 2018-09-08
 
 
 --------------------------------
@@ -25,7 +25,7 @@ Below is a description of a simple cross-cluster option, which is to send lead d
 		# 2- local list_id to insert lead into(if not populated, will use external system's list_id for the lead)
 
 - The AGI script will use parameters defined in a Settings Container for the URL of the originating system's Non-Agent API and credentials
-	The originating server will need to set up a user of level 8 with view reports and Agent API abilities, and the ccc_lead_info API function enabled
+	The originating server will need to set up a user of level 8 with view reports and Agent API abilities, and the 'ccc_lead_info' API function enabled
 	You will need to add a Settings Container to hold the URL for the originating system to look up the lead data, something like this:
 	http://server/vicidial/non_agent_api.php?user=6666&pass=1234&source=test&function=ccc_lead_info&call_id=--A--call_id--B--
 
@@ -42,6 +42,7 @@ NOTES:
 	# If lead is not found on external system, call will go to the 'B' option in the call menu
 	# If container is not found, call will go to the 'C' option in the call menu
 	# If call_id is not defined, call will go to the 'D' option in the call menu
+	# If you are planning to use the 'force_fronter_leave_3way' function across this CCC connection, make sure you have that API permission set for the API user above