V 2.0
Call Disposition Analysis
Call Disposition Analysis API
Description
The Call Disposition Analysis API provides endpoints for analyzing call dispositions and agent statistics in a call center environment. This API allows users to retrieve detailed information about call outcomes, agent performance, and various metrics related to call dispositions.
Key features:
- Analyze call dispositions across different parameters
- Retrieve agent-specific performance statistics
- Apply filters to narrow down data analysis
- Support for various breakdown options (e.g., by call type, campaign, agent)
The API uses Elasticsearch for efficient data retrieval and aggregation, ensuring fast and accurate results even with large datasets.
Error Codes
The API uses the following error codes from the SarvErrors module:
Error Code | Message | Description |
---|---|---|
1502 | Invalid filter value | The filter value provided is not valid |
These error codes are used consistently across all endpoints in the API to provide clear and specific feedback on various error conditions that may occur during API calls.
Agent stats
Endpoint
-
Method: POST
-
Path:
deepcall/api/v2/callDispositionAnalysis/agentstats
Description
An API endpoint designed to retrieve agent call disposition statistics, enabling performance analysis of different agents and their call handling.
Request Parameters
Headers
Header | Value |
---|---|
Content-Type | application/json |
Body Parameters
Parameter | Type | Required | Description |
---|---|---|---|
s | string | Yes | Session Identifier |
userId | string | No* | User Identification |
token | string | No* | Authentication Token |
filter | object | No | Data Filtering Options |
*Note: Either session identifier or user credentials are mandatory for authentication.
Filtering Options
Supports filtering based on:
-
Date Range
-
Campaign ID
-
IVR Details
-
Call Status
-
Call Type
-
Destination Number (DID)
Response Types
Success Response
-
Status Code: 200 OK
-
Contains detailed agent performance metrics
-
Breakdown of call dispositions
-
Aggregated statistics per agent
Error Response
-
Status Code: 200 OK
-
Includes error message
-
Provides error code
-
Explains reason for request failure
Key Features
-
Elasticsearch-powered data retrieval
-
Agent-level performance tracking
-
Supports multiple filter combinations
-
Provides comprehensive call disposition insights
-
Maximum 100 agent records per request
Authentication
-
Session-based authentication
-
Token-based authentication
-
Flexible login mechanisms
Use Cases
-
Performance monitoring
-
Call center analytics
-
Agent productivity assessment
-
Disposition trend analysis
Would you like me to elaborate on any specific aspect of the API?
Agent stats
var axios = require('axios');
var data = '{"s":"{{ssid}}"}';
var config = {
method: 'post',
url: '{{brand}}/api/v2/callDispositionAnalysis/agentstats',
headers: {
'Content-Length': ''
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
setUrl('{{brand}}/api/v2/callDispositionAnalysis/agentstats');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Length' => ''
));
$request->setBody('{"s":"{{ssid}}"}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
import http.client
conn = http.client.HTTPSConnection("{{brand}}")
payload = "{\"s\":\"{{ssid}}\"}"
headers = {
'Content-Length': ''
}
conn.request("POST", "/api/v2/callDispositionAnalysis/agentstats", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
var client = new RestClient("{{brand}}/api/v2/callDispositionAnalysis/agentstats");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
var body = @"{" + "\n" +
@" ""s"":""{{ssid}}""" + "\n" +
@"}";
request.AddParameter("text/plain", body, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
curl --location -g --request POST '{{brand}}/api/v2/callDispositionAnalysis/agentstats' \
--data-raw '{
"s":"{{ssid}}"
}'
var request = http.Request('POST', Uri.parse('{{brand}}/api/v2/callDispositionAnalysis/agentstats'));
request.body = '''{\n "s":"{{ssid}}"\n}''';
http.StreamedResponse response = await request.send();
if (response.statusCode == 200) {
print(await response.stream.bytesToString());
}
else {
print(response.reasonPhrase);
}
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "%7B%7Bbrand%7D%7D/api/v2/callDispositionAnalysis/agentstats"
method := "POST"
payload := strings.NewReader(`{
"s":"{{ssid}}"
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
POST /api/v2/callDispositionAnalysis/agentstats HTTP/1.1
Host: {{brand}}
Content-Length: 22
{
"s":"{{ssid}}"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "{\n \"s\":\"{{ssid}}\"\n}");
Request request = new Request.Builder()
.url("{{brand}}/api/v2/callDispositionAnalysis/agentstats")
.method("POST", body)
.addHeader("Content-Length", "")
.build();
Response response = client.newCall(request).execute();
var myHeaders = new Headers();
myHeaders.append("Content-Length", "");
var raw = "{\n \"s\":\"{{ssid}}\"\n}";
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("{{brand}}/api/v2/callDispositionAnalysis/agentstats", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
CURL *curl;
CURLcode res;
curl = curl_easy_init();
if(curl) {
curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(curl, CURLOPT_URL, "%7B%7Bbrand%7D%7D/api/v2/callDispositionAnalysis/agentstats");
curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Length: ");
curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
const char *data = "{\n \"s\":\"{{ssid}}\"\n}";
curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
res = curl_easy_perform(curl);
}
curl_easy_cleanup(curl);
#import
dispatch_semaphore_t sema = dispatch_semaphore_create(0);
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"%7B%7Bbrand%7D%7D/api/v2/callDispositionAnalysis/agentstats"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
NSDictionary *headers = @{
@"Content-Length": @""
};
[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n \"s\":\"{{ssid}}\"\n}" dataUsingEncoding:NSUTF8StringEncoding]];
[request setHTTPBody:postData];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
dispatch_semaphore_signal(sema);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSError *parseError = nil;
NSDictionary *responseDictionary = [NSJSONSerialization JSONObjectWithData:data options:0 error:&parseError];
NSLog(@"%@",responseDictionary);
dispatch_semaphore_signal(sema);
}
}];
[dataTask resume];
dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);
open Lwt
open Cohttp
open Cohttp_lwt_unix
let postData = ref "{\n \"s\":\"{{ssid}}\"\n}";;
let reqBody =
let uri = Uri.of_string "%7B%7Bbrand%7D%7D/api/v2/callDispositionAnalysis/agentstats" in
let headers = Header.init ()
|> fun h -> Header.add h "Content-Length" ""
in
let body = Cohttp_lwt.Body.of_string !postData in
Client.call ~headers ~body `POST uri >>= fun (_resp, body) ->
body |> Cohttp_lwt.Body.to_string >|= fun body -> body
let () =
let respBody = Lwt_main.run reqBody in
print_endline (respBody)
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Content-Length", "")
$body = "{`n `"s`":`"{{ssid}}`"`n}"
$response = Invoke-RestMethod '{{brand}}/api/v2/callDispositionAnalysis/agentstats' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json
require "uri"
require "net/http"
url = URI("{{brand}}/api/v2/callDispositionAnalysis/agentstats")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Length"] = ""
request.body = "{\n \"s\":\"{{ssid}}\"\n}"
response = http.request(request)
puts response.read_body
printf '{
"s":"{{ssid}}"
}'| http --follow --timeout 3600 POST '{{brand}}/api/v2/callDispositionAnalysis/agentstats' \
Content-Length:
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
var semaphore = DispatchSemaphore (value: 0)
let parameters = "{\n \"s\":\"{{ssid}}\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{brand}}/api/v2/callDispositionAnalysis/agentstats")!,timeoutInterval: Double.infinity)
request.addValue("", forHTTPHeaderField: "Content-Length")
request.httpMethod = "POST"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
semaphore.signal()
return
}
print(String(data: data, encoding: .utf8)!)
semaphore.signal()
}
task.resume()
semaphore.wait()
Example Response
[{"key":"Date"
"value":"Fri
29 Nov 2024 03:35:50 GMT"}
{"key":"Content-Type"
"value":"application\/json; charset=utf-8"}
{"key":"Content-Length"
"value":"2"}
{"key":"Connection"
"value":"keep-alive"}
{"key":"Access-Control-Allow-Origin"
"value":"*"}
{"key":"Access-Control-Allow-Methods"
"value":"POST
GET
OPTIONS
PATCH
DELETE"}
{"key":"Access-Control-Allow-Headers"
"value":"X-Requested-With
content-type"}
{"key":"Access-Control-Allow-Credentials"
"value":"true"}
{"key":"Vary"
"value":"Origin"}
{"key":"ETag"
"value":"W\/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\""}
{"key":"Strict-Transport-Security"
"value":"max-age=31536000; includeSubDomains"}]
{}