diff --git a/agc_2-X/trunk/UPGRADE b/agc_2-X/trunk/UPGRADE index 71a3ec79..e0097a8f 100644 --- a/agc_2-X/trunk/UPGRADE +++ b/agc_2-X/trunk/UPGRADE @@ -564,6 +564,8 @@ OTHER CHANGES: 160. Added 'copy_user' function to the Non-Agent API. +161. Added 'add_did' function to the Non-Agent API. + diff --git a/agc_2-X/trunk/docs/NON-AGENT_API.txt b/agc_2-X/trunk/docs/NON-AGENT_API.txt index 3d512403..975ebe3a 100644 --- a/agc_2-X/trunk/docs/NON-AGENT_API.txt +++ b/agc_2-X/trunk/docs/NON-AGENT_API.txt @@ -1,4 +1,4 @@ -NON-AGENT API DOCUMENT Started: 2008-07-24 Updated: 2021-01-13 +NON-AGENT API DOCUMENT Started: 2008-07-24 Updated: 2021-02-09 This document describes the functions of an API(Application Programming Interface) for all functions NOT directly relating to the VICIDIAL Agent screen. @@ -45,6 +45,7 @@ server_refresh - forces a conf file refresh on all telco servers in the cluster check_phone_number - allows you to check if a phone number is valid and dialable logged_in_agents - list of agents that are logged in to the system update_campaign - updates campaign settings in the system +add_did - adds new Inbound DID entries to the system update_did - updates Inbound DID information 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 @@ -169,6 +170,7 @@ Changes: 201113-0713 - Added delete_did option to update_did function 201201-1625 - Added group_by_campaign option to agent_stats_export function 210113-1714 - Added copy_user function +210209-2014 - Added add_did function API Functions use the 'function' variable @@ -2020,6 +2022,54 @@ SUCCESS: update_campaign CAMPAIGN HAS BEEN UPDATED - 6666|1101 +-------------------------------------------------------------------------------- +add_did - adds new Inbound DID entries to the system in the vicidial_inbound_dids table + +NOTE: api user for this function must have user_level set to 8 or higher and "Modify DIDs" enabled + +REQUIRED FIELDS- +did_pattern - 2-50 characters, must be a valid DID in the system + NOTE: special characters in the did_pattern need to be URL encoded, for example the plus sign '+' must be sent as '%2B' +source - description of what originated the API call (maximum 20 characters) + +EDITABLE FIELDS- +did_description - 6-50 characters +active - Must be one of these: 'Y','N' +did_route - must be one of these: 'EXTEN','VOICEMAIL','AGENT','PHONE','IN_GROUP','CALLMENU','VMAIL_NO_INST' +record_call - must be one of these: 'Y','N','Y_QUEUESTOP' +extension - 1-50 digits +exten_context - 1-50 characters +voicemail_ext - 1-10 digits +phone_extension - 1-100 characters +server_ip - must be all numbers and dots, max 15 characters +group - a valid in-group group_id +filter_clean_cid_number - 1-20 characters + +Example URL strings for API calls: +http://server/vicidial/non_agent_api.php?source=test&user=6666&pass=1234&function=add_did&did_pattern=%2B1727555112&did_description=Updated+test+API+DID&active=Y +http://server/vicidial/non_agent_api.php?source=test&user=6666&pass=1234&function=add_did&did_pattern=7275553331&did_description=Testing+DID&active=N&did_route=EXTEN&record_call=Y_QUEUESTOP&extension=8300&exten_context=notdefault&voicemail_ext=8301&phone_extension=55000&server_ip=192.168.198.5&group=TEST_IN2&filter_clean_cid_number=R10 + +Example responses: +ERROR: add_did USER DOES NOT HAVE PERMISSION TO ADD DIDS - 6666 +ERROR: add_did YOU MUST USE ALL REQUIRED FIELDS - 6666|1 +ERROR: add_did NOT AN ALLOWED DID - 98762 +ERROR: add_did DID ALREADY EXISTS - 6666|1000 +ERROR: add_did DID DESCRIPTION MUST BE FROM 6 TO 50 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|012 +ERROR: add_did ACTIVE MUST BE Y OR N, THIS IS AN OPTIONAL FIELD - 6666|U +ERROR: add_did DID ROUTE IS NOT VALID, THIS IS AN OPTIONAL FIELD - 6666|12 +ERROR: add_did RECORD CALL MUST BE Y OR N, THIS IS AN OPTIONAL FIELD - 6666| +ERROR: add_did EXTENSION MUST BE FROM 1 TO 50 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666| +ERROR: add_did EXTENSION CONTEXT MUST BE FROM 1 TO 50 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666| +ERROR: add_did VOICEMAIL EXTENSION MUST BE FROM 1 TO 10 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666| +ERROR: add_did PHONE EXTENSION MUST BE FROM 1 TO 100 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666| +ERROR: add_did SERVER IP MUST BE A VALID SERVER IN THE SYSTEM, THIS IS AN OPTIONAL FIELD - 6666|0.0.0.0 +ERROR: add_did GROUP ID MUST BE A VALID INBOUND GROUP IN THE SYSTEM, THIS IS AN OPTIONAL FIELD - 6666|test +ERROR: add_did CLEAN CID NUMBER MUST BE FROM 1 TO 20 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666| +SUCCESS: add_did DID HAS BEEN ADDED - 6666|1101 + + + + -------------------------------------------------------------------------------- update_did - updates Inbound DID information in the vicidial_inbound_dids table diff --git a/agc_2-X/trunk/www/agc/images/arrow_green_down.png b/agc_2-X/trunk/www/agc/images/arrow_green_down.png new file mode 100644 index 00000000..1dde0b9f Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/arrow_green_down.png differ diff --git a/agc_2-X/trunk/www/agc/images/arrow_green_up.png b/agc_2-X/trunk/www/agc/images/arrow_green_up.png new file mode 100644 index 00000000..8e012497 Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/arrow_green_up.png differ diff --git a/agc_2-X/trunk/www/agc/images/arrow_red_down.png b/agc_2-X/trunk/www/agc/images/arrow_red_down.png new file mode 100644 index 00000000..585858f4 Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/arrow_red_down.png differ diff --git a/agc_2-X/trunk/www/agc/images/arrow_red_up.png b/agc_2-X/trunk/www/agc/images/arrow_red_up.png new file mode 100644 index 00000000..20e6c812 Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/arrow_red_up.png differ diff --git a/agc_2-X/trunk/www/agc/images/arrow_yellow_down.png b/agc_2-X/trunk/www/agc/images/arrow_yellow_down.png new file mode 100644 index 00000000..9b10de1c Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/arrow_yellow_down.png differ diff --git a/agc_2-X/trunk/www/agc/images/arrow_yellow_up.png b/agc_2-X/trunk/www/agc/images/arrow_yellow_up.png new file mode 100644 index 00000000..97598aa9 Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/arrow_yellow_up.png differ diff --git a/agc_2-X/trunk/www/agc/images/email_icon.png b/agc_2-X/trunk/www/agc/images/email_icon.png new file mode 100644 index 00000000..6fdf5434 Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/email_icon.png differ diff --git a/agc_2-X/trunk/www/agc/images/email_icon_white.png b/agc_2-X/trunk/www/agc/images/email_icon_white.png new file mode 100644 index 00000000..c4fc9c7a Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/email_icon_white.png differ diff --git a/agc_2-X/trunk/www/agc/images/fax_icon.png b/agc_2-X/trunk/www/agc/images/fax_icon.png new file mode 100644 index 00000000..eb07fa1c Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/fax_icon.png differ diff --git a/agc_2-X/trunk/www/agc/images/fax_icon_white.png b/agc_2-X/trunk/www/agc/images/fax_icon_white.png new file mode 100644 index 00000000..ac914dda Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/fax_icon_white.png differ diff --git a/agc_2-X/trunk/www/agc/images/search.png b/agc_2-X/trunk/www/agc/images/search.png new file mode 100644 index 00000000..4d838175 Binary files /dev/null and b/agc_2-X/trunk/www/agc/images/search.png differ diff --git a/agc_2-X/trunk/www/vicidial/non_agent_api.php b/agc_2-X/trunk/www/vicidial/non_agent_api.php index 6de178e8..2ad44363 100644 --- a/agc_2-X/trunk/www/vicidial/non_agent_api.php +++ b/agc_2-X/trunk/www/vicidial/non_agent_api.php @@ -159,10 +159,11 @@ # 201201-1625 - Added group_by_campaign option to agent_stats_export function # 201214-1547 - Fixes for PHP8 compatibility # 210113-1714 - Added copy_user function +# 210209-2014 - Added add_did function # -$version = '2.14-136'; -$build = '210113-1714'; +$version = '2.14-137'; +$build = '210209-2014'; $api_url_log = 0; $startMS = microtime(); @@ -6739,6 +6740,302 @@ if ($function == 'update_campaign') +################################################################################ +### add_did - adds new Inbound DID entries to the system in the vicidial_inbound_dids table +################################################################################ +if ($function == 'add_did') + { + if(strlen($source)<2) + { + $result = 'ERROR'; + $result_reason = "Invalid Source"; + echo "$result: $result_reason - $source\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + echo "ERROR: Invalid Source: |$source|\n"; + exit; + } + else + { + if ( (!preg_match("/ $function /",$api_allowed_functions)) and (!preg_match("/ALL_FUNCTIONS/",$api_allowed_functions)) ) + { + $result = 'ERROR'; + $result_reason = "auth USER DOES NOT HAVE PERMISSION TO USE THIS FUNCTION"; + echo "$result: $result_reason: |$user|$function|\n"; + $data = "$allowed_user"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + $stmt="SELECT count(*) from vicidial_users where user='$user' and vdc_agent_api_access='1' and modify_inbound_dids='1' and user_level >= 8 and active='Y';"; + $rslt=mysql_to_mysqli($stmt, $link); + $row=mysqli_fetch_row($rslt); + $allowed_user=$row[0]; + if ($allowed_user < 1) + { + $result = 'ERROR'; + $result_reason = "add_did USER DOES NOT HAVE PERMISSION TO ADD DIDS"; + $data = "$allowed_user"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + { + if ( (strlen($did_pattern)<2) or (strlen($did_pattern)>50) ) + { + $result = 'ERROR'; + $result_reason = "add_did YOU MUST USE ALL REQUIRED FIELDS"; + $data = "$did_pattern"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + { + $stmt="SELECT allowed_campaigns,admin_viewable_groups from vicidial_user_groups where user_group='$LOGuser_group';"; + if ($DB>0) {echo "|$stmt|\n";} + $rslt=mysql_to_mysqli($stmt, $link); + $row=mysqli_fetch_row($rslt); + $LOGallowed_campaigns = $row[0]; + $LOGadmin_viewable_groups = $row[1]; + + $admin_viewable_groupsSQL=''; + $WHEREadmin_viewable_groupsSQL=''; + if (!preg_match('/\-\-ALL\-\-/i',$LOGadmin_viewable_groups)) + { + $rawLOGadmin_viewable_groupsSQL = preg_replace("/ -/",'',$LOGadmin_viewable_groups); + $rawLOGadmin_viewable_groupsSQL = preg_replace("/ /","','",$rawLOGadmin_viewable_groupsSQL); + $admin_viewable_groupsSQL = "and user_group IN('---ALL---','$rawLOGadmin_viewable_groupsSQL')"; + $WHEREadmin_viewable_groupsSQL = "where user_group IN('---ALL---','$rawLOGadmin_viewable_groupsSQL')"; + } + + $stmt="SELECT count(*) from vicidial_inbound_dids where did_pattern='$did_pattern';"; + if ($DB>0) {echo "|$stmt|\n";} + $rslt=mysql_to_mysqli($stmt, $link); + $row=mysqli_fetch_row($rslt); + $did_exists=$row[0]; + if ($did_exists > 0) + { + $result = 'ERROR'; + $result_reason = "add_did DID ALREADY EXISTS"; + $data = "$did_pattern"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + { + $did_patternSQL = "did_pattern='$did_pattern'"; + $did_descriptionSQL=''; + $activeSQL=''; + $did_routeSQL=''; + $record_callSQL=''; + $extensionSQL=''; + $exten_contextSQL=''; + $voicemail_extSQL=''; + $phone_extensionSQL=''; + $server_ipSQL=''; + $groupSQL=''; + $filter_clean_cid_numberSQL=''; + + if (strlen($did_description) > 0) + { + if ( (strlen($did_description) > 50) or (strlen($did_description) < 6) ) + { + $result = 'ERROR'; + $result_reason = "add_did DID DESCRIPTION MUST BE FROM 6 TO 50 CHARACTERS, THIS IS AN OPTIONAL FIELD"; + $data = "$did_description"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + {$did_descriptionSQL = " ,did_description='$did_description'";} + } + if (strlen($active) > 0) + { + if ( ($active != 'Y') and ($active != 'N') ) + { + $result = 'ERROR'; + $result_reason = "add_did ACTIVE MUST BE Y OR N, THIS IS AN OPTIONAL FIELD"; + $data = "$active"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + {$activeSQL = " ,did_active='$active'";} + } + if (strlen($did_route) > 0) + { + if (preg_match("/^EXTEN$|^VOICEMAIL$|^AGENT$|^PHONE$|^IN_GROUP$|^CALLMENU$|^VMAIL_NO_INST$/",$did_route)) + {$did_routeSQL = " ,did_route='$did_route'";} + else + { + $result = 'ERROR'; + $result_reason = "add_did DID ROUTE IS NOT VALID, THIS IS AN OPTIONAL FIELD"; + $data = "$did_route"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + } + if (strlen($record_call) > 0) + { + if ( ($record_call != 'Y') and ($record_call != 'N') and ($record_call != 'Y_QUEUESTOP') ) + { + $result = 'ERROR'; + $result_reason = "add_did RECORD CALL MUST BE Y OR N, THIS IS AN OPTIONAL FIELD"; + $data = "$record_call"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + {$record_callSQL = " ,record_call='$record_call'";} + } + if (strlen($extension) > 0) + { + if (strlen($extension) > 50) + { + $result = 'ERROR'; + $result_reason = "add_did EXTENSION MUST BE FROM 1 TO 50 CHARACTERS, THIS IS AN OPTIONAL FIELD"; + $data = "$extension"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + {$extensionSQL = " ,extension='$extension'";} + } + if (strlen($exten_context) > 0) + { + if (strlen($exten_context) > 50) + { + $result = 'ERROR'; + $result_reason = "add_did EXTENSION CONTEXT MUST BE FROM 1 TO 50 CHARACTERS, THIS IS AN OPTIONAL FIELD"; + $data = "$exten_context"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + {$exten_contextSQL = " ,exten_context='$exten_context'";} + } + if (strlen($voicemail_ext) > 0) + { + if ( (strlen($voicemail_ext) > 10) or (strlen($voicemail_ext) < 1) ) + { + $result = 'ERROR'; + $result_reason = "add_did VOICEMAIL EXTENSION MUST BE FROM 1 TO 10 CHARACTERS, THIS IS AN OPTIONAL FIELD"; + $data = "$voicemail_ext"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + {$voicemail_extSQL = " ,voicemail_ext='$voicemail_ext'";} + } + if (strlen($phone_extension) > 0) + { + if ( (strlen($phone_extension) > 100) or (strlen($phone_extension) < 1) ) + { + $result = 'ERROR'; + $result_reason = "add_did PHONE EXTENSION MUST BE FROM 1 TO 100 CHARACTERS, THIS IS AN OPTIONAL FIELD"; + $data = "$phone_extension"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + {$phone_extensionSQL = " ,phone='$phone_extension'";} + } + if (strlen($server_ip) > 0) + { + $stmt="SELECT count(*) from servers where server_ip='$server_ip';"; + $rslt=mysql_to_mysqli($stmt, $link); + $row=mysqli_fetch_row($rslt); + $server_exists=$row[0]; + + if ($server_exists < 1) + { + $result = 'ERROR'; + $result_reason = "add_did SERVER IP MUST BE A VALID SERVER IN THE SYSTEM, THIS IS AN OPTIONAL FIELD"; + $data = "$server_ip"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + $server_ipSQL = " ,server_ip='$server_ip'"; + } + if (strlen($group) > 0) + { + $stmt="SELECT count(*) from vicidial_inbound_groups where group_id='$group';"; + $rslt=mysql_to_mysqli($stmt, $link); + $row=mysqli_fetch_row($rslt); + $group_exists=$row[0]; + + if ($group_exists < 1) + { + $result = 'ERROR'; + $result_reason = "add_did GROUP ID MUST BE A VALID INBOUND GROUP IN THE SYSTEM, THIS IS AN OPTIONAL FIELD"; + $data = "$group"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + $groupSQL = " ,group_id='$group'"; + } + if (strlen($filter_clean_cid_number) > 0) + { + if ( (strlen($filter_clean_cid_number) > 20) or (strlen($filter_clean_cid_number) < 1) ) + { + $result = 'ERROR'; + $result_reason = "add_did CLEAN CID NUMBER MUST BE FROM 1 TO 20 CHARACTERS, THIS IS AN OPTIONAL FIELD"; + $data = "$filter_clean_cid_number"; + echo "$result: $result_reason: |$user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + exit; + } + else + {$filter_clean_cid_numberSQL = " ,filter_clean_cid_number='$filter_clean_cid_number'";} + } + + $addSQL = "$did_patternSQL$did_descriptionSQL$activeSQL$did_routeSQL$record_callSQL$extensionSQL$exten_contextSQL$voicemail_extSQL$phone_extensionSQL$server_ipSQL$groupSQL$filter_clean_cid_numberSQL"; + + $addSQL = preg_replace("/^ ,/",'',$addSQL); + $stmt="INSERT INTO vicidial_inbound_dids SET $addSQL;"; + $rslt=mysql_to_mysqli($stmt, $link); + $add_count = mysqli_affected_rows($link); + $did_id = mysqli_insert_id($link); + if ($DB) {echo "$add_count|$did_id|$stmt|\n";} + + ### LOG INSERTION Admin Log Table ### + $SQL_log = "$stmt|"; + $SQL_log = preg_replace('/;/', '', $SQL_log); + $SQL_log = addslashes($SQL_log); + $stmt="INSERT INTO vicidial_admin_log set event_date='$NOW_TIME', user='$user', ip_address='$ip', event_section='DIDS', event_type='ADD', record_id='$did_id', event_code='ADMIN API ADD DID', event_sql=\"$SQL_log\", event_notes='did: $did_pattern did_id: $did_id inserted: $add_count';"; + if ($DB) {echo "|$stmt|\n";} + $rslt=mysql_to_mysqli($stmt, $link); + + $result = 'SUCCESS'; + $result_reason = "add_did DID HAS BEEN ADDED"; + $data = "$did_pattern"; + echo "$result: $result_reason - $user|$data\n"; + api_log($link,$api_logging,$api_script,$user,$agent_user,$function,$value,$result,$result_reason,$source,$data); + } + } + } + } + exit; + } +################################################################################ +### END add_did +################################################################################ + + + + + ################################################################################ ### update_did - updates Inbound DID information in the vicidial_inbound_dids table ################################################################################