api
61 posts.
Rebuilding CRM integrations after migrating to VICIdial
Your CRM integrations will not transfer from a cloud dialer to VICIdial automatically. Here is how to assess what you had and rebuild it correctly.
Read postHow to Call the VICIdial API From Your App (PHP, Python, Node)
The VICIdial Non-Agent and Agent APIs are plain HTTP GET requests — here is how to call them correctly from PHP, Python, and Node.js with real examples.
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 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 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 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 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 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 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 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 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 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 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 postHow to add a number to the DNC list with add_dnc_phone
Use the add_dnc_phone API to push a phone number onto a campaign or internal DNC list without opening the admin screen.
Read postHow to create an inbound DID with the add_did API
Create an inbound DID and route it to an in-group, extension or call menu over HTTP with the VICIdial add_did API function.
Read postRemoving a number from DNC with delete_dnc_phone
Call the delete_dnc_phone API to pull a phone number back off a campaign or internal DNC list when it was added by mistake.
Read postEditing campaign dial presets with update_presets
Add, edit, list or delete a campaign's quick-dial presets over HTTP using the VICIdial update_presets API function.
Read postHow to register a SIP phone with the add_phone API
Use the add_phone API to create a SIP extension on your VICIdial server from code instead of clicking through the admin screen.
Read postChanging a DID's routing with update_did
Edit an inbound DID's description, routing target, recording flag, and more from a single API call with update_did.
Read postUnblocking a number with delete_fpg_phone
Call delete_fpg_phone to pull a number out of a Filter Phone Group so the dialer stops skipping it.
Read postCloning a DID with copy_did
Duplicate an existing inbound DID's routing onto one or more new numbers in a single API call with copy_did.
Read postReading the dial hopper with hopper_list
Pull the live contents of a campaign's dial hopper, lead by lead, with the hopper_list API call.
Read postValidating a number before dialing with check_phone_number
Check that a phone number is the right length, in a dialable area code, and not on a DNC list before you dial it.
Read postReading a list's details with list_info
Pull a lead list's name, campaign, active flag and lead counts straight from VICIdial with the list_info API function.
Read postListing your campaigns with campaigns_list
Dump every campaign's ID, dial method, dial level and dial prefix in one read-only call with the VICIdial campaigns_list API.
Read postHow to feed the dial hopper with hopper_bulk_insert
Push a batch of lead_ids straight into the dial hopper from one API call, with priority and local-time checks.
Read postBlocking a number with the add_fpg_phone API
Use add_fpg_phone to push a phone number into a Filter Phone Group so the dialer skips it without touching your DNC lists.
Read postHow to change campaign settings with update_campaign
Change dial level, dial method, hopper level and more on a live VICIdial campaign over HTTP with the update_campaign API.
Read postHow IP Lists scope admin, agent and API access per user group
VICIdial gives every user group three independent IP whitelists for admin, agent and API access, so you can lock each surface to its own set of networks.
Read postHow to find the call ID ra_call_control needs
The ra_call_control API needs a call ID in its value field. Here is where that ID comes from and how to read it off a live remote-agent call.
Read postHow to update or delete a phone with the API
The update_phone function edits an existing VICIdial phone or removes it entirely — same endpoint, one flag decides which.
Read postWhat the server_refresh API does after phone changes
After you add or edit phones over the API, server_refresh pushes the conf files out to your telco servers so the changes take effect.
Read postHow to create a phone alias with the add_phone_alias API
A phone alias groups several phone logins under one name so a single login can ring a set of phones. Here is how to create one over the API.
Read postHow to add many phones at once in VICIdial
Loop the add_phone API over a list of extensions to create dozens of phones at once, then run one refresh to make them all live.
Read postHow to add a phone with the add_phone API
Add a VICIdial phone entry over HTTP with the add_phone function — required fields, protocol options, and the responses you get back.
Read postDiagnosing API integration failures with the API Log Report
When a CRM integration stops pushing leads or updating dispositions, the API Log Report filters by user, function, and result so you can see exactly what failed.
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 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 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 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 postEvery value of the transfer_conference API: BLIND_TRANSFER, LOCAL_CLOSER, and more
The transfer_conference value field decides what happens to the call. Here is each option, what it expects, and when to reach for it.
Read posttw_check and md_check: blocking transfers when a 3-way is already active
Two optional safety flags on the transfer API stop an agent from stacking a new 3-way on top of one they never cleaned up. Here is what each checks.
Read postdial_override on the transfer API: dialing an exact number with no prefix
The dial_override flag tells the transfer API to dial exactly the number you pass, skipping the campaign dial prefix and phone code. Here is when that matters.
Read postThe recording API: starting and stopping a recording mid-transfer
The recording function in the agent API starts and stops recordings on demand, even in the middle of a transfer. Here is how START, STOP, STATUS, and the stage tag work.
Read postThe transfer_conference API: scripting transfers and 3-way calls
The transfer_conference call lets an outside program drive an agent's transfer frame: hangups, blind transfers, closer hops, and 3-way calls all from one URL.
Read postcid_choice and group_alias on a 3-way: setting caller ID from the API
When you open a 3-way through the transfer API, two fields decide what caller ID the third party sees: group_alias and cid_choice. Here is how each works.
Read postAPI New Lead URL: Pushing New Leads to an External System
The API New Lead URL fires a web request every time a lead is added through VICIdial's API. Here is how to use it to sync new leads to your CRM.
Read post