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

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

@@ -64,6 +64,7 @@ campaigns_list - displays information about all campaigns in the system
 hopper_list - displays information about leads in the hopper for a campaign
 update_alt_url - updates/adds/displays alternate dispo call url entries for a campaign
 update_presets - updates/adds/displays/deletes campaign preset entries
+lead_dearchive - moves a lead from the archive to active leads table
 
 
 New scripts:
@@ -210,6 +211,7 @@ Changes:
 230614-0828 - Added container_list function
 230721-1753 - Added insert for daily RT monitoring
 231109-0933 - Added archived_lead option to multiple functions
+231109-2022 - Added lead_dearchive function
 
 
 API Functions use the 'function' variable
@@ -962,6 +964,30 @@ lead_id|callback_type|recipient|callback_status|lead_status|callback_date|entry_
 
 
 
+--------------------------------------------------------------------------------
+lead_dearchive - moves a lead from the archive to active leads table
+
+NOTE: api user for this function must have user_level set to 8 or higher and "modify leads" enabled
+
+REQUIRED FIELDS-
+source -		description of what originated the API call (maximum 20 characters)
+lead_id -		16-40 characters
+
+Example URL strings for API calls:
+http://server/vicidial/non_agent_api.php?source=test&user=6666&pass=1234&function=lead_dearchive&lead_id=274071
+
+Example responses:
+ERROR: lead_dearchive USER DOES NOT HAVE PERMISSION TO MODIFY LEAD INFO - 6666|0
+ERROR: lead_dearchive INVALID SEARCH PARAMETERS - 6666||
+ERROR: lead_dearchive LEAD INSERT FAILED - 6666||
+ERROR: lead_dearchive NON-ARCHIVED LEAD FOUND - 6666||
+ERROR: lead_dearchive ARCHIVED LEAD NOT FOUND - 6666||
+SUCCESS: lead_dearchive LEAD DE-ARCHIVED - 6666|274071|1|1
+
+
+
+
+
 --------------------------------------------------------------------------------
 update_log_entry - updates the status of a vicidial_log or vicidial_closer_log entry