VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Lead Management → Lead Callback Info

AI-generated

Summary

Retrieve callback information for a specific lead from the VICIdial system.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion)
  • function (required) — API function name, auto-filled with 'lead_callback_info'.
  • user — Username from the VICIdial credential.
  • pass — Password from the VICIdial credential.
  • source — Source defined in the VICIdial credential.
  • lead_id (required) — Lead ID to retrieve callback information.
  • stage — Output format, defaults to 'pipe'.
  • header — Include header in output.
  • search_location — Location to search for the lead, defaults to 'LIST'.
  • requestOptions — Additional request options, including batching and SSL settings.

Output shape

a detailed record containing the callback information for the specified lead

The output includes callback details based on the lead ID provided. Ensure that the lead ID exists in the VICIdial system to receive valid data.

Examples

Example 1: Retrieve callback details for lead with ID '12345' and output in JSON format with headers included.

{ 'baseURL': 'https://example.com', 'lead_id': '12345', 'stage': 'json', 'header': 'YES' }

Discussion