Added Agent API pause_code function

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

agc_2-X/trunk/docs/AGENT_API.txt

@@ -1,4 +1,4 @@
-AGENT API DOCUMENT		Started: 2008-07-03	Updated: 2012-09-13
+AGENT API DOCUMENT		Started: 2008-07-03	Updated: 2014-01-26
 
 This document describes the functions of an API(Application Programming Interface)
 for the VICIDIAL Agent screen. This functionality will be rather limited at first
@@ -30,6 +30,7 @@ recording - sends a recording start/stop signal or status of agent recording
 webserver - display webserver information, very useful for load balanced setups
 webphone_url - display the webphone url for the current agent's session
 call_agent - send a call to connect the agent to their session
+pause_code - set a pause code if the agent is paused
 
 
 New scripts:
@@ -737,6 +738,32 @@ SUCCESS: call_agent function sent - 6666
 
 
 
+--------------------------------------------------------------------------------
+pause_code - 
+
+DESCRIPTION:
+set a pause code for an agent that is paused
+
+VALUES:
+ value - pause code to set, must be 6 characters or less
+
+NOTES:
+this function will not work if the agent is not paused
+
+EXAMPLE URLS:
+http://server/agc/api.php?source=test&user=6666&pass=1234&agent_user=1000&function=pause_code&value=BREAK
+
+RESPONSES:
+ERROR: no user found - 6666
+ERROR: agent_user is not logged in - 6666 
+ERROR: pause_code not valid - 6666|JUMPING
+ERROR: pause_code error - agent is not paused - 6666
+SUCCESS: pause_code function sent - 6666
+
+
+
+
+