API Documentation

AI Summary

The AI Summary API retrieves AI-generated call summaries, call journey analysis, quality metrics, insights, and processing status for one or more calls. This API supports retrieving summaries for up to 10 calls in a single request.

URL https://{Subdomain}.qevalpro.com/api/ScorecardAI/AISummary
Method POST
Sub Domains “app” or “ai”

1. API Headers

Every API request must include the following headers:

Header Value
Authorization Bearer <Generated_Token>  (generated after successful login)
X-API-KEY

<Your_Unique_API_Key>  (generated after successful login)

Note: The API key is provided by the QEval team. If unavailable, contact Qeval@etechtexas.com
 

2. Request Body

</> JSON 
{
    "callIds": [
        {
            "callId": "CALL1123456",
            "campaign": "123",
            "callDate": "2024-04-15"
        },
        {
            "callId": "CALL789012",
            "campaign": "123",
            "callDate": "2024-04-16"
        }
    ]
}

Request Parameters
 
S.No Name Type Description Is Required?
1 callIds Array List of call objects (maximum 10) Yes
2 callIds[].callId String Unique call identifier Yes
3 callIds[].campaign String Campaign ID associated with the call Yes
4 callIds[].callDate String Call date in yyyy-MM-dd format Yes

Validation Rules

Rule Description
callIds Cannot be null or empty
callIds Maximum 10 call records per request
callDate Must be in yyyy-MM-dd format
campaign Required for retrieving AI summaries
callId Must be a valid call identifier

3. Response Examples

Success

</> JSON 
[
    {
        "CallId": "eb4ebfj34",
        "AI_Summary": {
            "call_id": "eb4ebfj34"
        },
        "AI_Summary_Status": "Completed"
    },
    {
        "CallId": "eb4fwrtrtb52t1",
        "AI_Summary": "AI summary not available.",
        "AI_Summary_Status": "FAILED"
    }
]

Status Codes

Code Status Description
200 Success AI summary data retrieved successfully

Response Parameters

Evaluation-Level Fields

Field Description
CallId Unique call identifier
AI_Summary AI-generated summary object or failure message
AI_Summary_Status Processing status of the AI summary

AI Summary Object

The AI summary may contain the following sections:

Section Description
wrap_up_notes AI-generated wrap-up notes and agent summary
call_journey Overall call flow analysis
chapters Time-stamped call chapter breakdown
interaction_analysis Classification and resolution analysis
quality_metrics Customer sentiment and interaction quality analysis
insights AI-generated answers to configured business questions

Interaction Analysis Fields

Field Description
primary_category Main category of the interaction
complexity_level Call complexity assessment
service_type Type of customer interaction
resolution_status Resolution status
follow_up_required Indicates whether follow-up is needed
escalation_details Escalation information

Quality Metrics Fields

Field Description
customer_sentiment_beginning Customer sentiment at call start
customer_sentiment_overall Overall customer sentiment
customer_sentiment_end Customer sentiment at call end
customer_sentiment_quotes Supporting customer statements
resolution_confidence AI confidence in resolution
notable_agent_behaviors Key positive or negative agent behaviors

Failure Response

</> JSON 
[
    {
        "Message": "callIds array is required and must not be empty."
    }
]

Status Codes

Code Status Description
400 Bad Request Invalid request format
401 Unauthorised Invalid username/password
405 Method Not Allowed Requested method is not supported for the resource
406 Not Acceptable Exception occurred while processing the request
500 Internal Server Error Server encountered an error

AI Summary Status Values

Status Description
Completed AI summary generated successfully
FAILED AI processing failed
call_id not found Specified call could not be located
In Progress AI summary generation is still in progress

Notes

  • Authentication is mandatory for accessing this API.
  • A maximum of 10 calls can be requested in a single API call.
  • Each call must include a valid callId, campaign, and callDate.
  • AI summaries are returned only after AI processing has completed.
  • Failed or unavailable summaries return an appropriate status message instead of the summary object.
  • The API supports bulk retrieval of AI summaries for multiple calls in a single request.
  • Results may include call journey analysis, customer sentiment analysis, chapter segmentation, wrap-up notes, and AI-generated business insights.

    ×

    Contact Us