Added call_status_stats API function

Added vendor lead code filtering option to Lead Export Report

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

agc_2-X/trunk/docs/NON-AGENT_API.txt

@@ -1,4 +1,4 @@
-NON-AGENT API DOCUMENT           Started: 2008-07-24         Updated: 2017-12-29
+NON-AGENT API DOCUMENT           Started: 2008-07-24         Updated: 2018-01-09
 
 This document describes the functions of an API(Application Programming 
 Interface) for all functions NOT directly relating to the VICIDIAL Agent screen. 
@@ -44,7 +44,7 @@ update_campaign - updates campaign settings in the system
 phone_number_log - exports list of calls placed to one of more phone numbers
 ccc_lead_info - outputs lead data for cross-cluster-communication call
 lead_status_search - displays all field values of all leads that match the status and call date in request
-
+call_status_stats - report on number of calls made by campaign and ingroup, with hourly and status breakdowns
 
 New scripts:
 /vicidial/non_agent_api.php - the script that is accessed to execute commands
@@ -131,6 +131,7 @@ Changes:
 170609-1107 - Added ccc_lead_info function
 170615-0006 - Added DIAL status for manual dial agent calls that have not been answered, to 4 functions
 171229-1602 - Added lead_status_search function
+180109-1313 - Added call_status_stats function
 
 
 API Functions use the 'function' variable
@@ -1488,6 +1489,45 @@ NOTE: real_time_sub_status field can consist of: DEAD, DISPO, 3-WAY, PARK, RING,
 
 
 
+--------------------------------------------------------------------------------
+call_status_stats - report on number of calls made by campaign and ingroup, with hourly and status breakdowns
+
+NOTE: api user for this function must have user_level set to 8 or higher and "view reports" enabled
+
+REQUIRED FIELDS-
+campaigns -		Campaigns to return stats on.  Use "---ALL---" or "ALLCAMPAIGNS" for all campaigns, or use single dash delimiters if 
+                        requesting more than one specific campaign
+
+OPTIONAL FIELDS-
+query_date -	Date to report on, leave blank to default to today's date.  Must be in YYYY-MM-DD format
+ingroups -	List of ingroups to report on.  Leave blank for all ingroups belonging to the campaigns specified in the "campaigns" variable.
+		Use dash delimiters if requesting more than one ingroup.
+statuses -	List of specific statuses to report on.  Leave blank for all, or use dash delimiters if requesting more than one status.
+
+
+Example URL strings for API calls:
+http://server/vicidial/non_agent_api.php?user=6666&pass=1234&function=call_status_stats&campaigns=---ALL---&query_date=2017-11-24 (returns all campaigns and ingroups for 11/24/17)
+http://server/vicidial/non_agent_api.php?user=6666&pass=1234&function=call_status_stats&campaigns=TESTCAMP-TESTCAMP2&query_date=2017-11-24&statuses=NP-TD&ingroups=AGENTDIRECT 
+(returns stat counts for TESTCAMP and TESTCAMP2 campaigns, and AGENTDIRECT ingroup, for 11/24/27 for calls dispositioned as NP and TD)
+
+
+Example responses:
+ERROR: call_status_stats INVALID OR MISSING CAMPAIGNS
+ERROR: auth USER DOES NOT HAVE PERMISSION TO USE THIS FUNCTION
+ERROR: call_status_stats USER DOES NOT HAVE PERMISSION TO VIEW STATS
+
+A SUCCESS response will not show "SUCCESS", but instead will just print the results in the following format:
+campaign_id/ingroup|total calls|human answered calls|hourly breakdown(HH-count,HH-count,etc...)|status breakdown(status-count,status-count,etc...)
+
+Hourly and status breakdowns are delimited by comma, and each hour/status count is delimited by dash, as seen below:
+
+TESTCAMP|26|26|00-0,01-1,02-1,03-0,04-0,05-0,06-0,07-0,08-0,09-0,10-0,11-3,12-4,13-2,14-4,15-1,16-0,17-2,18-0,19-0,20-0,21-6,22-1,23-1|NP-4,TD-22|
+AGENTDIRECT|2|2|00-0,01-0,02-0,03-0,04-0,05-0,06-0,07-0,08-0,09-0,10-0,11-1,12-1,13-0,14-0,15-0,16-0,17-0,18-0,19-0,20-0,21-0,22-0,23-0|TD-2|
+
+
+
+
+
 --------------------------------------------------------------------------------
 update_campaign - updates campaign information in the vicidial_campaigns table