Overview

The Call-Ai Reporting API's enables the user to retrieve various types of data and metrics for business and analytics reports related to DVA conversations using Call-Ai RESTful API's . It provides access to call transactions including CDR, call transcripts, call recordings and and other key performance metrices to integrate into your application or 3rd party BI tools.

Fetch CDR

Filtering call data from a CDR (Call Detail Record) list involves sorting and selecting specific call information based on various criteria.

Endpoint URL

https://api.call-ai.com/reporting-ms/reporting/api/v1/analytics/filtercallDatacdrList

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

POST https://api.call-ai.com/reporting-ms/v1/reporting/api/v1/analytics/filtercallDatacdrList

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

{
    "tenant_id": "tenant_12345",
    "offset": 5,
    "limit": 10,
    "order_by": "DESC",
    "field": "call_date",
    "condition": {
        "ani": "9098765432",
        "call_direction": "INBOUND",
        "dnis": "9876234567",
        "tenant_id": "tenant_12345",
        "call_date": {
            "start_date": "2023-01-01",
            "end_date": "2023-04-01"
        }
    }
}

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Fetch Agent Call Detail

The api allows the user to get call data details from the agent.

Endpoint URL

https://api.call-ai.com/reporting-ms/reporting/api/v1/analytics/callDataagent/{uid}

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

GET https://api.call-ai.com/reporting-ms/v1/reporting/api/v1/analytics/callDataagent/{uid}

Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Fetch Queue|Team Detail

The api allows the user to get call data details from the queue.

Endpoint URL

https://api.call-ai.com/reporting-ms/reporting/api/v1/analytics/callDataqueue/{uid}

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

GET https://api.call-ai.com/reporting-ms/v1/reporting/api/v1/analytics/callDataqueue/{uid}

Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Fetch Call Recording

The api facilites to fetch the call recordings.

Endpoint URL

https://api.call-ai.com/reporting-ms/reporting/api/v1/analytics/recording/{uid}

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

GET https://api.call-ai.com/reporting-ms/v1/reporting/api/v1/analytics/recording/{uid}

Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Fetch Call Transcript

The api facilites to fetch the call transcripts.

Endpoint URL

https://api.call-ai.com/reporting-ms/reporting/api/v1/analytics/transcript/{tenant_id}/{bot_id}/{uid}

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

GET https://api.call-ai.com/reporting-ms/v1/reporting/api/v1/analytics/transcript/{tenant_id}/{bot_id}/{uid}

Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Delete Call Recording

This API facilitates the deletion of call recordings.

Endpoint URL

https://api.call-ai.com/reporting-ms/reporting/api/v1/analytics/recording/{uid}

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

DELETE https://api.call-ai.com/reporting-ms/v1/reporting/api/v1/analytics/recording/{uid}

Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Delete Call Transcript

This API facilitates the deletion of chat transcripts.

Endpoint URL

https://api.call-ai.com/reporting-ms/reporting/api/v1/analytics/transcript/{tenant_id}/{bot_id}/{uid}

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

DELETE https://api.call-ai.com/reporting-ms/v1/reporting/api/v1/analytics/transcript/{tenant_id}/{bot_id}/{uid}

Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:

Fetch Total Call Duration In/Out

The api facilites to fetch thecall duration by its call direction.

Endpoint URL

https://api.call-ai.com/reporting-ms/reporting/api/v1/analytics/total-call-duration/direction

Request Variables (Header Params)

You can retrieve the access token by entering the below-mentioned values in the Request Variables:

Request Variables (Body Param)

It takes a JSON request body with the following notable parameter:

Sample Request

POST https://api.call-ai.com/reporting-ms/v1/reporting/api/v1/analytics/total-call-duration/direction

Content-Type: application/json
Cache-Control: no-cache
Authorization: Bearer •••••••••
Ocp-Apim-Subscription-Key: •••••••••

{
    "tenant_id": "tenant_12345",
    "date_filter": true,
    "range": {
        "start_date": "2023-01-01",
        "end_date": "2023-04-01"
    }
}

Response Variable

Response Schema

A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below: