V 2.0
Directory
Overview
The Directory API provides functionality to manage contact information. With this API, you can create, update, and retrieve contacts, as well as manage sticky agents, account managers, and other related operations.
Authentication
Authentication is required for all endpoints. You can use either:
-
SSID (Session ID)
-
User ID and Token
These must be included in the request body for each API call.
Base URL
The base URL for all API endpoints is: deepcall/api/v2/Directory
Error Codes
The following table shows specific error codes for the Directory API, extracted from SarvErrors.js:
Error Code | Description |
---|---|
1501 | Sticky agent error |
1502 | Type is not valid |
1503 | Account manager error |
1504 | Failed to create directory |
1505 | CLI does not exist |
1506 | Group ID does not exist |
1507 | Agent does not exist in the given group ID |
1508 | Expiry must be greater than or equal to -1 |
1509 | Expiry must be integer value |
1510 | DNC error |
In addition to these specific error codes, there may also be general error codes such as:
Error Code | Description |
---|---|
1000 | Invalid parameter |
1005 | Invalid contact number |
1012 | No data found |
These error codes will help developers better understand and troubleshoot API responses.
Dnc Get
Endpoint
-
Method: POST
-
Path:
deepcall/api/v2/getDnc/
Description: This endpoint allows you to retrieve the Do Not Contact (DNC) status for a specific contact in the user's directory.
Use Case: Checking if a contact has requested not to be contacted before initiating communication.
Parameters:
Name | Type | Required | Description |
---|---|---|---|
contact | String | Yes | The contact number to check DNC status for |
ssid | String | Conditional | Session ID (required if userId and token not provided) |
userId | String | Conditional | User ID (required if ssid not provided) |
token | String | Conditional | Authentication token (required if ssid not provided) |
Notes:
-
Ensure that the contact number is valid and in the correct format.
-
The
dnc
field in the response represents the DNC status:-
If
dnc
is 0, the contact is not on the DNC list. -
If
dnc
is a positive integer, it represents the Unix timestamp until which the contact is on the DNC list. -
If
dnc
is -1, the contact is permanently on the DNC list.
-
-
If the contact doesn't exist in the directory, the API will still return a success response with
dnc
set to 0. -
The DNC status is separate from the blacklist status. A contact can be on the DNC list without being blacklisted, and vice versa.
-
Always respect the DNC status when initiating contact, as contacting individuals on the DNC list may violate regulations.
-
The API will return appropriate error codes and messages for invalid inputs or server-side issues.
-
Ensure you have the necessary permissions to access DNC information.
-
Consider implementing a caching mechanism if you need to check DNC status frequently for the same contacts.
-
It's a good practice to check the DNC status before any outbound communication, including calls, SMS, or emails.
-
The DNC status may be set based on customer requests, regulatory requirements, or internal policies.
-
Be aware of any applicable laws or regulations (like TCPA in the US) that govern the use of DNC lists in your jurisdiction.
-
Consider logging DNC status checks for compliance and auditing purposes.
Dnc Get
var axios = require('axios');
var data = '{"ssid":"{{ssid}}","contact":{{callernumber}}}';
var config = {
method: 'post',
url: '{{brand}}/api/v2/Directory/getDnc',
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/Directory/getDnc');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Length' => ''
));
$request->setBody('{"ssid":"{{ssid}}","contact":{{callernumber}}}');
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}}\",\"contact\":{{callernumber}}}"
headers = {
'Content-Length': ''
}
conn.request("POST", "/api/v2/Directory/getDnc", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
var client = new RestClient("{{brand}}/api/v2/Directory/getDnc");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
var body = @"{" + "\n" +
@" ""ssid"":""{{ssid}}""," + "\n" +
@" ""contact"":{{callernumber}}" + "\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/Directory/getDnc' \
--data-raw '{
"ssid":"{{ssid}}",
"contact":{{callernumber}}
}'
var request = http.Request('POST', Uri.parse('{{brand}}/api/v2/Directory/getDnc'));
request.body = '''{\n "ssid":"{{ssid}}",\n "contact":{{callernumber}}\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/Directory/getDnc"
method := "POST"
payload := strings.NewReader(`{
"ssid":"{{ssid}}",
"contact":{{callernumber}}
}`)
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/Directory/getDnc HTTP/1.1
Host: {{brand}}
Content-Length: 57
{
"ssid":"{{ssid}}",
"contact":{{callernumber}}
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "{\n \"ssid\":\"{{ssid}}\",\n \"contact\":{{callernumber}}\n}");
Request request = new Request.Builder()
.url("{{brand}}/api/v2/Directory/getDnc")
.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 \"contact\":{{callernumber}}\n}";
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("{{brand}}/api/v2/Directory/getDnc", 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/Directory/getDnc");
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 \"contact\":{{callernumber}}\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/Directory/getDnc"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
NSDictionary *headers = @{
@"Content-Length": @""
};
[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n \"ssid\":\"{{ssid}}\",\n \"contact\":{{callernumber}}\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 \"contact\":{{callernumber}}\n}";;
let reqBody =
let uri = Uri.of_string "%7B%7Bbrand%7D%7D/api/v2/Directory/getDnc" 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 `"contact`":{{callernumber}}`n}"
$response = Invoke-RestMethod '{{brand}}/api/v2/Directory/getDnc' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json
require "uri"
require "net/http"
url = URI("{{brand}}/api/v2/Directory/getDnc")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Length"] = ""
request.body = "{\n \"ssid\":\"{{ssid}}\",\n \"contact\":{{callernumber}}\n}"
response = http.request(request)
puts response.read_body
printf '{
"ssid":"{{ssid}}",
"contact":{{callernumber}}
}'| http --follow --timeout 3600 POST '{{brand}}/api/v2/Directory/getDnc' \
Content-Length:
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
var semaphore = DispatchSemaphore (value: 0)
let parameters = "{\n \"ssid\":\"{{ssid}}\",\n \"contact\":{{callernumber}}\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{brand}}/api/v2/Directory/getDnc")!,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":"Thu
28 Nov 2024 11:25:01 GMT"}
{"key":"Content-Type"
"value":"application\/json; charset=utf-8"}
{"key":"Content-Length"
"value":"60"}
{"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\/\"3c-9ANyygunzy0Iq4ovwyERvLnysXg\""}
{"key":"Strict-Transport-Security"
"value":"max-age=31536000; includeSubDomains"}]
{
"status": "success",
"code": 200,
"data": {
"dnc": 1732863032000
}
}