VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Reporting Monitoring → Recording Lookup

AI-generated

Summary

Lookup recordings in VICIdial using specified parameters.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name; defaults to 'recording_lookup'.
  • user — User ID from VICIdial credential.
  • pass — Password from VICIdial credential.
  • source — Source from VICIdial credential.
  • agent_user — Agent user ID.
  • lead_id — Lead ID.
  • date — Date in YYYY-MM-DD format.
  • uniqueid — Unique identifier for the recording.
  • extension — Extension associated with the recording.
  • stage — Output format (csv, tab, pipe, json).
  • header — Include header in output (YES or NO).
  • duration — Include recording duration (Y or N).
  • requestOptions — Additional request options like batching and timeout.

Output shape

a list of recording details or a success/failure response

The operation may return different formats based on the 'stage' parameter.

Examples

Example 1: Lookup a specific recording by its unique ID.

Set the 'uniqueid' parameter with the desired recording's unique identifier.

Example 2: Fetch recordings for an agent on a specific date.

Set the 'agent_user' and 'date' parameters accordingly.

Discussion