The operator's perspective.
On VICIdial, SIP, and call-center ops.
7-day free trial · Cancel anytime · Pay with card or USDT
Page 15
Operator writing, sorted newest first.
How 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.
Click-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.
Pulling 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.
Switching 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.
Adding 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.
Reading 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.
Reading 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.
Unblocking 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.
Editing a phone group with update_phone_alias
Change or delete an existing phone alias over HTTP with update_phone_alias. Required fields, the delete_alias flag, permissions, and responses.
Exporting inbound-call logs with did_log_export
Pull a single day of inbound calls to a DID with the did_log_export API function - required fields, output format, permissions, and errors.
Changing 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.
How 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.
Blocking 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.
How to create a calling list with the add_list API
Create a new VICIdial calling list over HTTP with the add_list function. Required fields, optional settings, copying custom fields, and responses.
Removing 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.
How 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.
Cloning 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.
Editing 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.
How 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.
Grouping phones with add_phone_alias
Create a phone alias that maps one login to several phones using the add_phone_alias Non-Agent API call. Fields, permissions, and example responses.
How 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.
Reading 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.
Reading live call-status counts with call_status_stats
Get per-campaign and per-ingroup call counts with hourly and status breakdowns from the call_status_stats API - fields, filters, and output format.
Pulling every call to a number with phone_number_log
Export every inbound and outbound call placed to one or more phone numbers with the phone_number_log API - fields, filters, and the indexing caveat.