VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Lead Management → Lead All Info

AI-generated

Summary

Retrieve detailed information for a specific lead in VICIdial.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name, auto-filled as 'lead_all_info'.
  • user — Comes from the VICIdial credential, representing the username.
  • pass — Comes from the VICIdial credential, representing the password.
  • source — Defaults to the source defined in the VICIdial credential.
  • lead_id (required) — Lead ID for the lead you want to retrieve.
  • phone_number — Phone number associated with the lead (6-16 digits).
  • custom_fields — Specify whether to include custom fields in the response.
  • force_entry_list_id — Force the entry list ID if needed.
  • archived_lead — Specify whether to include archived leads.
  • stage — Output format, can be set to 'csv', 'tab', 'pipe', or 'json'.
  • header — Specify whether to include a header in the output.
  • requestOptions — Various options for request handling, including batching, timeout, and proxy settings.

Output shape

a detailed record of the lead's information, dependent on provided parameters

Response shape can vary based on the selected output format and included options.

Discussion