VIQ Analytics Contract

This project contains the contract definitions for the VIQ Analytics service.

APIs

Data Download APIs

Get Call Details

• Endpoint: POST /api/datadownload/search
• Description: Search and retrieve detailed call records with various filters
• Request: DataDownloadRequest
• Response: GenericListResponse<CallRecordForCallDetailsDB>

Get Call Logs

• Endpoint: POST /api/datadownload/call-logs
• Description: Get simplified call logs with basic information, audio recording URL, and transcript URL
• Request: CallLogsRequest
• Response: GenericListResponse<CallLogDB>

Call Logs API Details

The Call Logs API provides a simplified view of call records with the following features:

Request Parameters (CallLogsRequest)

• From (DateTime?): Start date for filtering calls
• To (DateTime?): End date for filtering calls
• Limit (int): Maximum number of records to return (default: 50)
• Offset (int): Number of records to skip for pagination (default: 0)

Response (CallLogDB)

• CallRecordId: Unique identifier for the call record
• AgentName: Name of the agent who made/received the call
• ContactName: Name of the contact or account
• ContactPhoneNumber: Phone number of the contact
• StartTime: When the call started
• Duration: Call duration in seconds
• Direction: Call direction (incoming/outgoing)
• Outcome: Call outcome/result
• Status: Call status
• AudioRecordUrl: URL to access the call recording
• TranscriptUrl: URL to access the call transcript
• TeamName: Team name associated with the call
• CampaignName: Campaign name associated with the call

Features

• Returns call records in descending order by start time
• Only includes completed calls (excludes in-progress, queued, paused, ringing, initiated)
• Includes audio recording and transcript URLs when available
• Supports pagination with limit and offset parameters
• Filters by date range when provided
• Includes basic call information and related entity details (agent, contact, team, campaign)

Authentication

• Requires API Key authentication
• Rate limited to 200 requests per 60 seconds