agent-api
35 posts.
How to Build Click-to-Dial With the VICIdial Agent API
The VICIdial Agent API's external_dial function lets your web app or CRM trigger an outbound call on an agent's live session with a single HTTP request.
Read postParking and unparking a call with the park_call function
Send a customer or a third party to the park extension and grab them back, including IVR park and swap options, from a logged-in agent session.
Read postControlling a remote agent's call with ra_call_control
Hang up or transfer a call that a remote agent is handling, with optional disposition and status, using three supported stages.
Read postStarting and stopping recordings with the recording function
How the recording agent-api function starts, stops, and reports call recordings against a logged-in VICIdial agent session.
Read postEnding an agent's call with external_hangup
How the external_hangup Agent API call drops the live customer call on a logged-in agent's screen from an outside system.
Read postAdding and dialing a lead with external_add_lead
How the external_add_lead Agent API function drops a new lead into a logged-in agent's manual dial list, with optional DNC checks.
Read postSeeing an agent's inbound groups with agent_ingroup_info
How the agent_ingroup_info non-agent API shows the in-group and outbound auto-dial settings a logged-in agent currently has.
Read postHow to drive the agent screen with the Agent API
The Agent API acts on a live, logged-in agent's screen. Here is the function, user, pass, source pattern and the plain-text responses you'll get back.
Read postPausing and resuming an agent with external_pause
How the external_pause Agent API function pauses or resumes a logged-in VICIdial agent from an outside system, and what happens mid-call.
Read postDriving transfers and conferences with transfer_conference
Hang up, blind-transfer, send to voicemail, dial another agent, or build a 3-way call from an agent session through one flexible API function.
Read postReading one agent's live status with agent_status
How the agent_status non-agent API returns one agent's real-time state, current call, and sub-status in a single line you can poll.
Read postSending DTMF tones from the agent screen with send_dtmf
Push a string of touch-tones into an agent's live session to drive an IVR menu, with pound, star, and silence encoded as P, S, and Q.
Read postPlaying audio to a caller with the audio_playback function
How the audio_playback agent-api function plays, stops, pauses, and resumes an audio file in a live VICIdial agent session.
Read postListing logged-in agents with logged_in_agents
Pull a live roster of every agent currently logged in to VICIdial, with status and session details, using the logged_in_agents API call.
Read postStarting a silent listen with the blind_monitor API
How the blind_monitor non-agent API dials a supervisor's phone and drops them into an agent's live session to monitor, barge or swap.
Read postUpdating the agent form remotely with update_fields
How the update_fields Agent API function rewrites the customer information panel on a logged-in VICIdial agent's screen and reloads panels.
Read postListing audio prompts with the sounds_list API
How the sounds_list non-agent API outputs the audio files in your VICIdial audio store, with format and sort options.
Read postLaunching the agent's webphone with webphone_url
How the webphone_url agent-api function displays or launches the configured webphone URL for a live VICIdial agent session.
Read postRinging an agent's phone with the call_agent function
How the call_agent agent-api function places a call from a VICIdial agent session to the agent's own phone.
Read postSwitching an agent's inbound groups with change_ingroups
How the change_ingroups Agent API function adds, removes, or replaces the in-groups a logged-in VICIdial agent takes calls from.
Read postClick-to-dial from your app with external_dial
Trigger a manual dial on a logged-in agent's screen from your own app using the external_dial Agent API function and its lead-search options.
Read postReading the agent's current lead with st_get_agent_active_lead
Look up the lead a logged-in agent has on their screen using a CRM AgentID, returning lead_id, phone, and a few key fields.
Read postAgent-controlled stereo recording with stereo_recording
How the stereo_recording agent-api function begins, ends, and reports a two-channel recording on a live VICIdial agent session.
Read postPulling a disposition report with call_dispo_report
Get a disposition breakdown by campaign, ingroup, or DID over a date range with the call_dispo_report Non-Agent API function.
Read postSetting a disposition from outside with external_status
Disposition a call on a logged-in agent's screen from your own app with external_status, including scheduled callbacks and their options.
Read postReading an inbound group's live state with in_group_status
How the in_group_status non-agent API returns calls waiting and agent counts for one or more inbound groups in a single line.
Read postThe recording Agent API function: START, STOP, STATUS
Use VICIdial's recording Agent API function to trigger, stop, and inspect call recordings programmatically from any external app.
Read postHow to start and stop a recording from your own app
A practical guide to wiring VICIdial's recording Agent API function into an external CRM or app so you control exactly when recordings start and stop.
Read postHow to tag a recording mid-call with the stage parameter
VICIdial's stage parameter lets you append a custom suffix to a recording filename at the moment you start it via the Agent API—making segments easy to identify later.
Read postThe stereo_recording API function explained: BEGIN, END, STATUS
VICIdial's stereo_recording Agent API function starts and stops agent-controlled stereo recordings via BEGIN, END, and STATUS—here's exactly how it works.
Read postFix: "agent_user does not have a live call" on a transfer
This transfer error means the system does not see a live call on the agent it was told to act on. Here is what causes the mismatch and how to clear it.
Read postforce_fronter_leave_3way: making the fronter drop off a 3-way automatically
The force_fronter_leave_3way function lets a closer push the fronter off a shared 3-way call without waiting for the fronter to click anything.
Read postFix: "agent_user has previous active 3-way calls" when starting a 3-way
This error is a safety check firing on leftover 3-way calls. Here is what tw_check does, why it blocks you, and how to clear the stale conference.
Read postforce_fronter_audio_stop: silencing fronter audio playback after a handoff
After a fronter leaves a 3-way, audio they were playing can keep running in their session. force_fronter_audio_stop kills it from the closer side.
Read postHide Customer Hangup Button: removing Hangup Customer and Hangup Both from the agent screen
The Hide Customer Hangup Button setting removes the Hangup Customer and Hangup Both buttons. Here is exactly what it hides and when it is the right call.
Read post