Actions58
- Lead Management Actions
- User Agent Management Actions
- Campaign Management Actions
- Phone DID Management Actions
- List Management Actions
- Reporting Monitoring Actions
- System Info Actions
- Other Operations Actions
Overview
This node interacts with the VICIdial Non-Agent API to retrieve the status of a specific user agent (an agent user ID) within a VICIdial system. It is useful for monitoring or managing agent statuses programmatically, such as checking if an agent is logged in, paused, or active. Practical applications include integrating real-time agent status checks into workflows for call center management, automating reporting, or triggering actions based on agent availability.
Properties
| Name | Meaning |
|---|---|
| Function | The API function to call; here it is fixed to "Agent Status" |
| User | API user credential used for authentication |
| Pass | API password credential used for authentication |
| Source | Description of what originated the API call; default is "n8n" |
| Agent User | The agent user ID whose status is being queried |
| Stage | Output format of the response; options: Csv, Tab, Pipe, Json |
| Header | Whether to include a header row in the output; options: YES, NO |
| Include Ip | Whether to include IP information in the output; options: YES, NO |
Output
The node outputs the response from the VICIdial API in the specified format (csv, tab, pipe, or json). The main output is available in the json field of the returned data. If the output format is one of the text-based formats (CSV, tab-delimited, pipe-delimited), the node returns the raw string data accordingly. If JSON is selected, the output will be structured JSON data representing the agent's status details.
No binary data output is indicated by the source code or properties.
Dependencies
- Requires access to a VICIdial server with the Non-Agent API enabled.
- Requires credentials consisting of an API user and password.
- The node uses the base URL configured in the credentials to send requests.
- No additional external services are required beyond the VICIdial API endpoint.
Troubleshooting
- Authentication errors: Ensure that the API user and password credentials are correct and have sufficient permissions to query agent status.
- Incorrect agent user ID: Verify that the
agent_userproperty matches a valid agent user ID in the VICIdial system. - Output format issues: If the output is not as expected, check the
stageandheaderproperties to ensure the desired format and headers are set correctly. - Network or connectivity problems: Confirm that the VICIdial server is reachable from the n8n instance and that the base URL is correctly configured.
- API errors: The node may return error messages from the VICIdial API; review these messages for clues about invalid parameters or server-side issues.
Links and References
- VICIdial Official Website
- VICIdial Non-Agent API Documentation (for detailed API usage and parameters)