ViciDial/agc_2-X
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added recording and webserver functions to the agent API

Browse Source 
git-svn-id: svn://192.168.202.10@1847 3d104415-ff17-0410-8863-d5cf3c621b8a
This commit is contained in:
mattf
2012-08-10 12:31:28 +00:00
parent 92c9ff43c0
commit b6a201f6b0
9 changed files with 313 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/AGENT_API.txt
+83 -4
View File
@@ -1,4 +1,4 @@
AGENT API DOCUMENT Started: 2008-07-03 Updated: 2011-11-14
AGENT API DOCUMENT Started: 2008-07-03 Updated: 2012-08-10
This document describes the functions of an API(Application Programming Interface)
for the VICIDIAL Agent screen. This functionality will be rather limited at first
@@ -26,6 +26,8 @@ send_dtmf - sends dtmf signal string to agent's session
transfer_conference - sends several commands related to the agent transfer-conf frame
park_call - sends command to park customer or grab customer from park or ivr
logout - logs the agent out of the agent interface
recording - sends a recording start/stop signal or status of agent recording
webserver - display webserver information, very useful for load balanced setups
New scripts:
@@ -79,6 +81,41 @@ VERSION: 2.0.5-2|BUILD: 90116-1229|DATE: 2009-01-15 14:59:33|EPOCH: 1222020803
--------------------------------------------------------------------------------
webserver -
DESCRIPTION:
shows version and build of the API, along with the date/time
VALUES: NONE
EXAMPLE URL:
http://server/agc/api.php?source=test&user=6666&pass=1234&function=webserver
RESPONSES:
Webserver Data:
set.timezone: America/New_York
abbr.timezone: EDT
dst.timezone: 1
uname: Linux dev-db 2.6.34.8-0.2-default #1 SMP 2011-04-06 18:11:26 +0200 x86_64
host name: dev-db
server name: www.vicidial.org
php version: 5.3.3
apache version: Apache/2.2.15 (Linux/SUSE)
apache processes: 13
system loadavg: 0.06
disk_free_space: 444174315520
date.timezone: America/New_York
max_execution_time: 360
max_input_time: 360
memory_limit: 128M
post_max_size: 48M
upload_max_filesize: 42M
default_socket_timeout: 360
--------------------------------------------------------------------------------
external_hangup -
@@ -324,9 +361,6 @@ SUCCESS: change_ingroups function set - YES| TEST_IN SALESLINE -|6666
--------------------------------------------------------------------------------
update_fields -
@@ -377,6 +411,8 @@ SUCCESS: update_fields lead updated - 6666|1234|87498|vendor_lead_code='1234567'
--------------------------------------------------------------------------------
set_timer_action -
@@ -405,6 +441,8 @@ SUCCESS: set_timer_action lead updated - 6666|1234|MESSAGE_ONLY|test message|15
--------------------------------------------------------------------------------
st_login_log -
@@ -427,6 +465,8 @@ SUCCESS: st_login_log user found - 6666
--------------------------------------------------------------------------------
st_get_agent_active_lead -
@@ -451,6 +491,8 @@ SUCCESS: st_get_agent_active_lead lead found - 6666|7275551212|123456|9987-12347
--------------------------------------------------------------------------------
ra_call_control -
@@ -487,6 +529,8 @@ SUCCESS: ra_call_control hungup - 6666|Y0315201639000402027|HANGUP
--------------------------------------------------------------------------------
send_dtmf -
@@ -510,6 +554,8 @@ SUCCESS: send_dtmf function set - QQQQ1234SQQQQQ6654P|6666
--------------------------------------------------------------------------------
park_call -
@@ -539,6 +585,8 @@ SUCCESS: park_call function set - PARK_CUSTOMER|6666
--------------------------------------------------------------------------------
transfer_conference -
@@ -592,6 +640,37 @@ SUCCESS: transfer_conference function set - LOCAL_CLOSER|SALESLINE||YES|6666
--------------------------------------------------------------------------------
recording -
DESCRIPTION:
sends a recording start/stop signal or status of agent recording
VALUES:
value -
REQUIRED, choices are below
START - sends a "start recording" signal to the agent screen
(you can have multiple recordings going at the same time)
STOP - sends a "stop recording" signal to the agent screen
(this will stop all active recordings onthe agent screen)
STATUS - displays results of active recording and agent session information
(returns: user|recording_id|filename|server|start_time|agent_server|session|agent_status)
EXAMPLE URLS:
http://server/agc/api.php?source=test&user=6666&pass=1234&agent_user=1000&function=recording&value=START
http://server/agc/api.php?source=test&user=6666&pass=1234&agent_user=1000&function=recording&value=STOP
http://server/agc/api.php?source=test&user=6666&pass=1234&agent_user=1000&function=recording&value=STATUS
RESPONSES:
ERROR: no user found - 6666
ERROR: agent_user is not logged in - 6666
ERROR: stop recording error - 6666|||||192.168.1.5|8600051|PAUSED
SUCCESS: recording function sent - 6666|STOP||||192.168.1.5|8600051|PAUSED
SUCCESS: recording function sent - 6666|START||||192.168.1.5|8600051|PAUSED
NOTICE: not recording - 6666|||||192.168.1.5|8600051|PAUSED
NOTICE: recording active - 6666|121242|20120810-012008__6666_|192.168.1.5|2012-08-10 01:20:10|192.168.1.5|8600051|PAUSED