V 2.0

Agent Dashboard

Overview

This API facilitates interactions with an agent dashboard system. It allows for retrieving agent details, fetching recent call data, managing notes, and accessing contact information. It includes error handling for robust integration and delivers results in JSON format.


Base URL

The base URL for all API endpoints is: deepcall/api/v2/agentDashboard


Error Handling

The API uses standardized error codes for ease of troubleshooting. Below is a comprehensive list of error codes:

Error Code Message Description
1000 Invalid parameter Missing or invalid parameters in the request.
1001 Invalid data type Incorrect data type provided in the request.
1002 UserId not provided userId is a required field.
1003 AgentId does not exist The specified agentId does not exist.
1004 File not found The requested file is unavailable.
1014 Invalid token The provided token is invalid or expired.
1020 Token not found The request does not include a token.
1032 Internal server error A general server-side error occurred.
1039 User account suspended The user's account is currently suspended.
1501 Agent dashboard error Issues occurred while fetching agent dashboard data.

Notes Add

{{brand}}/api/v2/agentDashboard/notesAdd

Endpoint

Description

Adds a note for a specific caller number and call ID. This endpoint allows users to attach additional information or comments related to a particular call.

Request Parameters

Parameter Type Required Description
ssid String Yes Session ID of the user.
userId String Yes Unique identifier of the user.
token String Yes Authentication token for API access.
callerNumber String Yes Caller number to attach the note to.
content String Yes The content of the note.
callId String Yes The call ID associated with the note.

Notes

Notes Add

var axios = require('axios');
var data = '{"ssid":"{{ssid}}","callerNumber":"{{callernumber}}","content":"notes Add test","callId":"{{callid}}"}';

var config = {
 method: 'post',
 url: '{{brand}}/api/v2/agentDashboard/notesAdd',
 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/agentDashboard/notesAdd');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
 'follow_redirects' => TRUE
));
$request->setHeader(array(
 'Content-Length' => ''
));
$request->setBody('{"ssid":"{{ssid}}","callerNumber":"{{callernumber}}","content":"notes Add test","callId":"{{callid}}"}');
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 = "{\"ssid\":\"{{ssid}}\",\"callerNumber\":\"{{callernumber}}\",\"content\":\"notes Add test\",\"callId\":\"{{callid}}\"}"
headers = {
 'Content-Length': ''
}
conn.request("POST", "/api/v2/agentDashboard/notesAdd", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
var client = new RestClient("{{brand}}/api/v2/agentDashboard/notesAdd");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
var body = @"{" + "\n" +
@"    ""ssid"":""{{ssid}}""," + "\n" +
@"    ""callerNumber"":""{{callernumber}}""," + "\n" +
@"    ""content"":""notes Add test""," + "\n" +
@"    ""callId"":""{{callid}}""" + "\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/agentDashboard/notesAdd' \
--data-raw '{
    "ssid":"{{ssid}}",
    "callerNumber":"{{callernumber}}",
    "content":"notes Add test",
    "callId":"{{callid}}"
}'
var request = http.Request('POST', Uri.parse('{{brand}}/api/v2/agentDashboard/notesAdd'));
request.body = '''{\n    "ssid":"{{ssid}}",\n    "callerNumber":"{{callernumber}}",\n    "content":"notes Add test",\n    "callId":"{{callid}}"\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/agentDashboard/notesAdd"
   method := "POST"

   payload := strings.NewReader(`{
    "ssid":"{{ssid}}",
    "callerNumber":"{{callernumber}}",
    "content":"notes Add test",
    "callId":"{{callid}}"
}`)

   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/agentDashboard/notesAdd HTTP/1.1
Host: {{brand}}
Content-Length: 123

{
    "ssid":"{{ssid}}",
    "callerNumber":"{{callernumber}}",
    "content":"notes Add test",
    "callId":"{{callid}}"
}
OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "{\n    \"ssid\":\"{{ssid}}\",\n    \"callerNumber\":\"{{callernumber}}\",\n    \"content\":\"notes Add test\",\n    \"callId\":\"{{callid}}\"\n}");
Request request = new Request.Builder()
   .url("{{brand}}/api/v2/agentDashboard/notesAdd")
   .method("POST", body)
   .addHeader("Content-Length", "")
   .build();
Response response = client.newCall(request).execute();
var myHeaders = new Headers();
myHeaders.append("Content-Length", "");

var raw = "{\n    \"ssid\":\"{{ssid}}\",\n    \"callerNumber\":\"{{callernumber}}\",\n    \"content\":\"notes Add test\",\n    \"callId\":\"{{callid}}\"\n}";

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("{{brand}}/api/v2/agentDashboard/notesAdd", 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/agentDashboard/notesAdd");
   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    \"ssid\":\"{{ssid}}\",\n    \"callerNumber\":\"{{callernumber}}\",\n    \"content\":\"notes Add test\",\n    \"callId\":\"{{callid}}\"\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/agentDashboard/notesAdd"]
   cachePolicy:NSURLRequestUseProtocolCachePolicy
   timeoutInterval:10.0];
NSDictionary *headers = @{
   @"Content-Length": @""
};

[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n    \"ssid\":\"{{ssid}}\",\n    \"callerNumber\":\"{{callernumber}}\",\n    \"content\":\"notes Add test\",\n    \"callId\":\"{{callid}}\"\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    \"ssid\":\"{{ssid}}\",\n    \"callerNumber\":\"{{callernumber}}\",\n    \"content\":\"notes Add test\",\n    \"callId\":\"{{callid}}\"\n}";;

let reqBody = 
   let uri = Uri.of_string "%7B%7Bbrand%7D%7D/api/v2/agentDashboard/notesAdd" 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    `"ssid`":`"{{ssid}}`",`n    `"callerNumber`":`"{{callernumber}}`",`n    `"content`":`"notes Add test`",`n    `"callId`":`"{{callid}}`"`n}"

$response = Invoke-RestMethod '{{brand}}/api/v2/agentDashboard/notesAdd' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json
require "uri"
require "net/http"

url = URI("{{brand}}/api/v2/agentDashboard/notesAdd")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Length"] = ""
request.body = "{\n    \"ssid\":\"{{ssid}}\",\n    \"callerNumber\":\"{{callernumber}}\",\n    \"content\":\"notes Add test\",\n    \"callId\":\"{{callid}}\"\n}"

response = http.request(request)
puts response.read_body
printf '{
    "ssid":"{{ssid}}",
    "callerNumber":"{{callernumber}}",
    "content":"notes Add test",
    "callId":"{{callid}}"
}'| http  --follow --timeout 3600 POST '{{brand}}/api/v2/agentDashboard/notesAdd' \
 Content-Length:
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif

var semaphore = DispatchSemaphore (value: 0)

let parameters = "{\n    \"ssid\":\"{{ssid}}\",\n    \"callerNumber\":\"{{callernumber}}\",\n    \"content\":\"notes Add test\",\n    \"callId\":\"{{callid}}\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{brand}}/api/v2/agentDashboard/notesAdd")!,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
 22 Nov 2024 06:46:51 GMT"}
{"key":"Content-Type"
"value":"application\/json; charset=utf-8"}
{"key":"Content-Length"
"value":"65"}
{"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\/\"41-lNUdZslEurs7LvPFRlaBEWkJonA\""}
{"key":"Strict-Transport-Security"
"value":"max-age=31536000; includeSubDomains"}]
 {
    "status": "error",
    "message": "callerNumber not valid",
    "code": 1503
}