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

Added more variables for add_did/update_did Non-Agent API functions

Browse Source 
git-svn-id: svn://192.168.202.10@3453 3d104415-ff17-0410-8863-d5cf3c621b8a
This commit is contained in:
mattf
2021-06-11 20:41:10 +00:00
parent 70b2001681
commit 0e1ffd4b1d
2 changed files with 219 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/NON-AGENT_API.txt
+26 -1
View File
@@ -1,4 +1,4 @@
NON-AGENT API DOCUMENT Started: 2008-07-24 Updated: 2021-05-17
NON-AGENT API DOCUMENT Started: 2008-07-24 Updated: 2021-06-11
This document describes the functions of an API(Application Programming
Interface) for all functions NOT directly relating to the VICIDIAL Agent screen.
@@ -187,6 +187,7 @@ Changes:
210402-1102 - Added 'custom_fields_delete' option for update_list function
210406-1047 - Added 'dialable_count' option to list_info function
210517-1850 - Added phone_code as modifiable field in update_lead function
210611-1610 - Added more variables for add_did/update_did functions
API Functions use the 'function' variable
@@ -2178,6 +2179,12 @@ server_ip - must be all numbers and dots, max 15 characters
group - a valid in-group group_id
menu_id - a valid call menu menu_id
filter_clean_cid_number - 1-20 characters
call_handle_method - If the route is IN_GROUP, this is the call handle method(CID, CIDLOOKUP, CLOSER, etc...), default 'CID'
agent_search_method - If the route is IN_GROUP, this is the agent search method(LO = Load-Balanced-Overflow, LB = Load-Balanced, SO = Server-Only), default 'LB'
list_id - If the route is IN_GROUP, this is the list ID(3-12 digits), default '999'
entry_list_id - If the route is IN_GROUP, this is the entry list ID(1-12 digits), default '0'
campaign_id - If the route is IN_GROUP, this is the campaign ID, default ''
phone_code - If the route is IN_GROUP, this is the phone code, default '1'
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
@@ -2200,6 +2207,12 @@ ERROR: add_did SERVER IP MUST BE A VALID SERVER IN THE SYSTEM, THIS IS AN OPTION
ERROR: add_did GROUP ID MUST BE A VALID INBOUND GROUP IN THE SYSTEM, THIS IS AN OPTIONAL FIELD - 6666|test
ERROR: add_did MENU ID MUST BE A VALID CALL MENU IN THE SYSTEM, THIS IS AN OPTIONAL FIELD - 6666|test_menu
ERROR: add_did CLEAN CID NUMBER MUST BE FROM 1 TO 20 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|
ERROR: add_did CALL HANDLE METHOD MUST BE FROM 3 TO 20 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|1
ERROR: add_did AGENT SEARCH METHOD MUST BE 2 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|1
ERROR: add_did LIST ID MUST BE FROM 3 TO 14 DIGITS, THIS IS AN OPTIONAL FIELD - 6666|1
ERROR: add_did ENTRY LIST ID MUST BE FROM 1 TO 14 DIGITS, THIS IS AN OPTIONAL FIELD - 6666|999999999999999
ERROR: add_did CAMPAIGN MUST BE FROM 1 TO 8 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|TESTCAMPS
ERROR: add_did PHONE CODE MUST BE FROM 1 TO 10 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|99999999999
SUCCESS: add_did DID HAS BEEN ADDED - 6666|1101
@@ -2229,6 +2242,12 @@ server_ip - must be all numbers and dots, max 15 characters
group - a valid in-group group_id
menu_id - a valid call menu menu_id
filter_clean_cid_number - 1-20 characters
call_handle_method - If the route is IN_GROUP, this is the call handle method(CID, CIDLOOKUP, CLOSER, etc...), default 'CID'
agent_search_method - If the route is IN_GROUP, this is the agent search method(LO = Load-Balanced-Overflow, LB = Load-Balanced, SO = Server-Only), default 'LB'
list_id - If the route is IN_GROUP, this is the list ID(3-12 digits), default '999'
entry_list_id - If the route is IN_GROUP, this is the entry list ID(1-12 digits), default '0'
campaign_id - If the route is IN_GROUP, this is the campaign ID, default ''
phone_code - If the route is IN_GROUP, this is the phone code, default '1'
delete_did - Can be one of these: 'Y','N' (default is 'N')
Example URL strings for API calls:
@@ -2253,6 +2272,12 @@ ERROR: update_did SERVER IP MUST BE A VALID SERVER IN THE SYSTEM, THIS IS AN OPT
ERROR: update_did GROUP ID MUST BE A VALID INBOUND GROUP IN THE SYSTEM, THIS IS AN OPTIONAL FIELD - 6666|test
ERROR: update_did MENU ID MUST BE A VALID CALL MENU IN THE SYSTEM, THIS IS AN OPTIONAL FIELD - 6666|test_menu
ERROR: update_did CLEAN CID NUMBER MUST BE FROM 1 TO 20 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|
ERROR: update_did CALL HANDLE METHOD MUST BE FROM 3 TO 20 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|1
ERROR: update_did AGENT SEARCH METHOD MUST BE 2 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|1
ERROR: update_did LIST ID MUST BE FROM 3 TO 14 DIGITS, THIS IS AN OPTIONAL FIELD - 6666|1
ERROR: update_did ENTRY LIST ID MUST BE FROM 1 TO 14 DIGITS, THIS IS AN OPTIONAL FIELD - 6666|999999999999999
ERROR: update_did CAMPAIGN MUST BE FROM 1 TO 8 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|TESTCAMPS
ERROR: update_did PHONE CODE MUST BE FROM 1 TO 10 CHARACTERS, THIS IS AN OPTIONAL FIELD - 6666|99999999999
NOTICE: update_did NO UPDATES DEFINED - 6666|
SUCCESS: update_did DID HAS BEEN DELETED - 6666|23|1101
SUCCESS: update_did DID HAS BEEN UPDATED - 6666|1101