

Hangs up the current customer call on the agent screenġ - the only valid value for this functionĮRROR: external_hangup not valid - 1|6666

Shows version and build of the API, along with the date/time SUCCESS: external_status function set - 6666|AĮRROR: agent_user is not logged in - 6666 Response to calls will return either an ERROR or a SUCCESS along with an explanation. To hangup the call, disposition it and then pause the agent, do the following in order: # language - currently only works for close window link: en=English, es=Spanish # close_window_link - will display a link to close the window, useful if you pop up the API link in a browser window # source - description of what originated the API call (maximum 20 characters) # agent_user - is the vicidial agent user whose session that you want to affect agc/api.php - the script that is accessed to execute commands
LIMIT TO DIAL CALLS ON A LEAD VICIDIAL CODE
Pause_code - set a pause code if the agent is paused Webphone_url - display the webphone url for the current agent's sessionĬall_agent - send a call to connect the agent to their session Webserver - display webserver information, very useful for load balanced setups

Recording - sends a recording start/stop signal or status of agent recording Logout - logs the agent out of the agent interface Park_call - sends command to park customer or grab customer from park or ivr Transfer_conference - sends several commands related to the agent transfer-conf frame Send_dtmf - sends dtmf signal string to agent's session Ra_call_control - remote agent call control: hangup/transfer calls being handled by remote agents St_get_agent_active_lead - looks up active lead info for an agent and outputs lead information St_login_log - looks up the vicidial_users.custom_three field and logs event from CRM Set_timer_action - sets timer action for the current call the agent is on Update_fields - changes values for selected data fields in the agent interface
LIMIT TO DIAL CALLS ON A LEAD VICIDIAL MANUAL
Preview_dial_action - sends a SKIP, DIALONLY, ALTDIAL, ADR3DIAL or FINISH when a lead is being previewed or manual alt dialĮxternal_add_lead - Adds a lead in the manual dial list of the campaign for logged-in agentĬhange_ingroups - changes the selected in-groups for a logged-in agent Version - shows version and build of the API, along with the date/timeĮxternal_hangup - sends command to hangup the current phone call for one specific agent(Hangup Customer)Įxternal_status - sends command to set the disposition for one specific agent and move on to next callĮxternal_pause - sends command to pause/resume an agent now if not on a call, or pause after their next call if on callĮxternal_dial - sends command to manually dial a number on the agent's screen There is also a new NON-agent API script, for more information on that, please This functionality will be rather limited at firstĪnd will be built upon as critical functions are identified and programmed into it. This document describes the functions of an API(Application Programming Interface)įor the VICIDIAL Agent screen.
