VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

List Management → List Info

AI-generated

Summary

Retrieve information about a specific list in VICIdial.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name, auto-filled as 'list_info'.
  • user — Comes from the VICIdial credential.
  • pass — Comes from the VICIdial credential.
  • source — Defaults to the source defined in the VICIdial credential.
  • list_id (required) — List ID to retrieve information for.
  • leads_counts — Specify if lead counts should be included ('Y' or 'N').
  • dialable_count — Specify if dialable count should be included ('Y' or 'N').
  • stage — Output format (CSV, Tab, Pipe, or JSON).
  • header — Include header in output ('YES' or 'NO').
  • requestOptions — Additional request options including batching, SSL settings, and timeout.

Output shape

a single record containing list details

Includes various fields based on the parameters specified, such as lead counts and dialable counts, depending on user selections.

Discussion