API Documentation

Call Upload Metadata

The Call Upload Metadata API ingests call metadata and optional call recordings into the QEval system. Uploaded records are created as evaluations with a status of “Not Evaluated”, allowing users to view and evaluate them later through Evaluation Search. When opened, the evaluation displays the default category fields automatically populated based on the uploaded metadata.

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

1. API Headers

Every API call must include two-factor authentication by providing the following headers:

Header Type Description
Authorisation String Bearer <Generated_Token> (generated after successful login)
X-API-KEY String

<Your_Unique_API_Key> (generated after successful login)

Note: If unavailable, email Qeval@etechtexas.com.

2. Sample Request (Payload)

</> JSON 
[
    {
        "Agentid": "015",
        "Supervisorid": "012",
        "ParentClient": "Etech",
        "Location": "Texas",
        "Number": "111111111118",
        "Disposition": "3",
        "CallDate": "01/12/2021",
        "CallLength": "120",
        "Partner": "",
        "Client": "ebs",
        "Program": "Inventory",
        "Calls": [
            {
                "Call1": "1.mp3"
            },
            {
                "Call2": "2.mp3"
            },
            {
                "Call3": "3.mp3"
            },
            {
                "Call4": "4.mp3"
            }
        ]
    }
]

Description for Request Parameters

S.No Name Type Description Is Required?
1 Agentid Integer Employee ID of the agent Yes
2 Supervisorid Integer Employee ID of the supervisor Yes
3 ParentClient String Name of the parent client Yes
4 Location String Location name Yes
5 Number String Contact number or interaction number Yes
6 Disposition Integer Disposition identifier Yes
7 CallDate Date (MM/dd/yyyy) Date of the call Yes
8 CallLength Integer Call duration in seconds Yes
9 Partner String Partner name No
10 Client String Client name Yes
11 Program String Program name Yes
12 Calls Array List of call recording files associated with the evaluation No

Validation Rules

Rule Description
Request Size Maximum request size allowed is 1 GB
Evaluations Per Request Maximum 500 evaluations can be submitted in a single request
Call Files Maximum 5 call recordings can be uploaded per evaluation
File Extensions Only .txt, .mp3, and .wav files are supported
File Names Uploaded call file names must exactly match the values provided in the Calls array
Metadata File Metadata must be uploaded in .txt format
Number Required when submitting evaluation metadata
Call Files Optional

3. Rate Limits

Limit Description
200 Requests Allowed per 35,000 seconds
500 Evaluations Maximum evaluations per API request

4. Response Examples

Success

</> JSON 
{
    "Message": "2 evaluations successfully processed."
}

Status Codes

Code Status Description
200 Success Evaluations processed successfully

Response Parameters

S.No Name Type Description
1 Message String Processing result returned by the API

Failure

</> JSON 
{
    "Message": "The request is invalid."
}

Status Codes

Code Status Description
400 Bad Request Invalid request payload or metadata format
401 Unauthorised Invalid or expired authentication token
405 Method Not Allowed Requested method is not supported for the resource
406 Not Acceptable Exception occurred while processing the request
413 Payload Too Large Request size exceeds the maximum allowed limit
500 Internal Server Error Exception occurred while processing the request

Notes

  • Authentication is mandatory for accessing this API.
  • Uploaded evaluations are created with a status of “Not Evaluated”.
  • Users can view uploaded records through Evaluation Search.
  • Opening an uploaded evaluation automatically displays the configured default category fields.
  • Call recordings are optional.
  • A maximum of 5 call recordings can be associated with a single evaluation.
  • The file names specified in the Calls array must exactly match the uploaded recording file names.
  • Supported file formats are .txt, .mp3, and .wav. 
  • The total request size must not exceed 1 GB.
  • A maximum of 500 evaluations can be submitted in a single API request.
  • The API supports bulk ingestion of evaluation metadata and associated call recordings.

    ×

    Contact Us