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

Added In-Group in_queue_nanque options

Browse Source 
Added optional phone_number search for lead_all_info function
Fix for Inbound Report with optional campaign-select AHT calc

git-svn-id: svn://192.168.202.10@3535 3d104415-ff17-0410-8863-d5cf3c621b8a
This commit is contained in:
mattf
2021-11-08 03:54:53 +00:00
parent 1ca244c6ae
commit 4242aeb447
13 changed files with 297 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/NON-AGENT_API.txt
+9 -6
View File
@@ -1,4 +1,4 @@
NON-AGENT API DOCUMENT Started: 2008-07-24 Updated: 2021-10-27
NON-AGENT API DOCUMENT Started: 2008-07-24 Updated: 2021-11-07
This document describes the functions of an API(Application Programming
Interface) for all functions NOT directly relating to the VICIDIAL Agent screen.
@@ -195,6 +195,7 @@ Changes:
210701-2050 - Added ingroup_rank/ingroup_grade options to the update_user function
210812-2640 - Added update of live agent records for ingroup_rank/ingroup_grade in the update_user function
210917-1615 - Added batch_update_lead function
211107-1556 - Added optional phone_number search for lead_all_info function
API Functions use the 'function' variable
@@ -756,13 +757,14 @@ A SUCCESS response will not show "SUCCESS", but instead will just print the valu
--------------------------------------------------------------------------------
lead_all_info - outputs all lead data for a lead(optionally including custom fields)
NOTE: api user for this function must have user_level set to 7 or higher and "view reports" enabled and modify_leads set to 1-4
NOTE: api user for this function must have user_level set to 7 or higher and "view reports" enabled and modify_leads set to 1-5
REQUIRED FIELDS-
source - description of what originated the API call (maximum 20 characters)
lead_id - 1-10 digits
OPTIONAL FIELDS-
phone_number - 6-19 digits, can be used in place of a lead_id(may return multiple records, up to 1000, most recently added lead first)
custom_fields - Y or N, default is N. If the field you want to pull is a custom field or not
force_entry_list_id - 3-12 digits, will override the lead's assigned entry_list_id to look for custom fields data for this lead from a different list
@@ -772,17 +774,18 @@ header - include a header(YES) or not(NO). This is optional, default is not to
Example URL strings for API calls:
http://server/vicidial/non_agent_api.php?source=test&user=6666&pass=1234&function=lead_all_info&lead_id=1079425
http://server/vicidial/non_agent_api.php?source=test&user=6666&pass=1234&function=lead_all_info&phone_number=3125551212
http://server/vicidial/non_agent_api.php?source=test&user=6666&pass=1234&function=lead_all_info&lead_id=1079425&header=YES&custom_fields=Y
http://server/vicidial/non_agent_api.php?source=test&user=6666&pass=1234&function=lead_all_info&lead_id=1079425&header=YES&custom_fields=Y&force_entry_list_id=999880
Example responses:
ERROR: lead_all_info USER DOES NOT HAVE PERMISSION TO GET LEAD INFO - 6666|0
ERROR: lead_all_info LIST NOT FOUND - 6666||
ERROR: lead_all_info LEAD NOT FOUND - 6666||
ERROR: lead_all_info LIST NOT FOUND - 6666|||
ERROR: lead_all_info LEAD NOT FOUND - 6666|||
A SUCCESS response will not show "SUCCESS", but instead will just print the results in the following format:
status|user|vendor_lead_code|source_id|list_id|gmt_offset_now|phone_code|phone_number|title|first_name|middle_initial|last_name|address1|address2|address3|city|state|province|postal_code|country_code|gender|date_of_birth|alt_phone|email|security_phrase|comments|called_count|last_local_call_time|rank|owner|entry_list_id
TD|6666|554443||501|-4.00|1|9998887112|Mr|Billy'Oj|U|O'Reillyo|ad1|ad2|ad3|city next|FL|U|33777||U|0000-00-00|bobo'brien|test@test.com||2017-06-01 18:38:41|79|2017-06-09 14:53:27|0|4646|0
status|user|vendor_lead_code|source_id|list_id|gmt_offset_now|phone_code|phone_number|title|first_name|middle_initial|last_name|address1|address2|address3|city|state|province|postal_code|country_code|gender|date_of_birth|alt_phone|email|security_phrase|comments|called_count|last_local_call_time|rank|owner|entry_list_id|lead_id
TD|6666|554443||501|-4.00|1|9998887112|Mr|Billy'Oj|U|O'Reillyo|ad1|ad2|ad3|city next|FL|U|33777||U|0000-00-00|bobo'brien|test@test.com||2017-06-01 18:38:41|79|2017-06-09 14:53:27|0|4646|0|98234789
docs/VICIDIAL_statuses.txt
+1
View File
@@ -78,3 +78,4 @@ UNKAL - CPD Unknown call sent to a message and message has been played
NVAINS - Default status for new inserted lead on phone NVA call
CLOSOP - In-Group Closing-Time option selected
PAUSMX - Pause Max Seconds timeout default status
IQNANQ - In-Queue call No-Agent-No-Queue drop