Agent API
Every documented function for controlling a logged-in agent session: pause, dial, hang up, disposition, transfer and status.
- File
- AGENT_API.txt
- Length
- 1,199 lines
- Covers
- VICIdial Agent API, agc/api.php, agent session control
- Source
- Reproduced unmodified from the VICIdial source
Read the document →Non-Agent API
The administrative API reference: leads, lists, campaigns, users, phones, DIDs, recordings and reporting functions.
- File
- NON-AGENT_API.txt
- Length
- 2,874 lines
- Covers
- VICIdial Non-Agent API, non_agent_api.php, add lead API
- Source
- Reproduced unmodified from the VICIdial source
Read the document →Call URL features
Call-triggered URL integrations and the full list of --A--variable--B-- substitutions available to them.
- File
- CALL_URL_FEATURES.txt
- Length
- 209 lines
- Covers
- VICIdial Call URL, VICIdial webhook, URL variable substitution
- Source
- Reproduced unmodified from the VICIdial source
Read the document →Agent events push
Browser-side agent event delivery, what it emits and the boundaries of treating it as an event stream.
- File
- AGENT_EVENTS_PUSH.txt
- Length
- 197 lines
- Covers
- VICIdial agent events, event push, browser events
- Source
- Reproduced unmodified from the VICIdial source
Read the document →CORS support
Cross-Origin Resource Sharing options, what they permit and how they interact with agent and API pages.
- File
- CORS_SUPPORT.txt
- Length
- 85 lines
- Covers
- VICIdial CORS, cross-origin, browser permission boundary
- Source
- Reproduced unmodified from the VICIdial source
Read the document →WebSockets support
In-application WebSocket extension points and what they are and are not intended to carry.
- File
- WEBSOCKETS_SUPPORT.txt
- Length
- 51 lines
- Covers
- VICIdial WebSocket, websockets, signaling
- Source
- Reproduced unmodified from the VICIdial source
Read the document →Chat and messaging
Agent, manager and customer chat behavior, permissions and the gates that control each channel.
- File
- CHAT_MESSAGING.txt
- Length
- 97 lines
- Covers
- VICIdial chat, agent messaging, customer chat
- Source
- Reproduced unmodified from the VICIdial source
Read the document →PJSIP support
The PJSIP channel driver boundary, version requirements and how VICIdial manages PJSIP configuration.
- File
- PJSIP_SUPPORT.txt
- Length
- 111 lines
- Covers
- VICIdial PJSIP, chan_sip migration, Asterisk SIP driver
- Source
- Reproduced unmodified from the VICIdial source
Read the document →VICIdial statuses
The built-in status and disposition codes with their meanings, as shipped with the source.
- File
- VICIDIAL_statuses.txt
- Length
- 88 lines
- Covers
- VICIdial statuses, disposition codes, status meanings
- Source
- Reproduced unmodified from the VICIdial source
Read the document →Custom fields
List-scoped custom field definitions, the dynamic tables behind them and the API and schema guardrails.
- File
- CUSTOM_FIELDS.txt
- Length
- 112 lines
- Covers
- VICIdial custom fields, dynamic tables, lead fields
- Source
- Reproduced unmodified from the VICIdial source
Read the document →D11Security and compliance
Two-factor authentication
The 2FA implementation, its settings and the recovery considerations that come with enabling it.
- File
- 2FA_TWO_FACTOR_AUTHENTICATION.txt
- Length
- 82 lines
- Covers
- VICIdial 2FA, two-factor authentication, admin security
- Source
- Reproduced unmodified from the VICIdial source
Read the document →D12Security and compliance
DNC.com integration
External do-not-call scrubbing: configuration, batch behavior and what the integration does and does not decide.
- File
- DNC-dot-COM_integration.txt
- Length
- 240 lines
- Covers
- VICIdial DNC, DNC.com, do not call scrubbing
- Source
- Reproduced unmodified from the VICIdial source
Read the document →D13Security and compliance
TILTX SHAKEN API
The optional outbound caller-identity signing integration and the arrangements it depends on.
- File
- TILTX_SHAKEN_API.txt
- Length
- 83 lines
- Covers
- VICIdial STIR SHAKEN, TILTX, caller identity signing
- Source
- Reproduced unmodified from the VICIdial source
Read the document →ViciBox backup and restore
Backup and restore procedure notes for ViciBox installations.
- File
- vicibox-backup-restore-guide.md
- Length
- 567 lines
- Covers
- ViciBox backup, VICIdial restore, disaster recovery
- Source
- Reproduced unmodified from the VICIdial source
Read the document →ViciBox kernel upgrade
Kernel upgrade procedure notes for ViciBox installations.
- File
- vicibox-kernel-upgrade-guide.md
- Length
- 298 lines
- Covers
- ViciBox kernel, kernel upgrade, VICIdial maintenance
- Source
- Reproduced unmodified from the VICIdial source
Read the document →