V 2.0
Group
Description
The Group API allows you to manage agent groups within the system. You can create, update, delete, and list groups. Groups are used to organize agents and manage their permissions and settings collectively.
Base URL
The base URL for all API endpoints is: deepcall/api/v2/Group
Authentication
All endpoints require authentication. Use one of the following methods:
-
SSID
-
User ID and Token
Error Responses
All endpoints may return the following error response:
Field | Type | Description |
---|---|---|
status | string | "error" |
message | string | Description of the error |
code | number | Error code |
Error Codes
Code | Description |
---|---|
1501 | The 'Name' field was not provided in the request |
1502 | GroupId is required |
1503 | Group not found or not authorized |
Notes
-
The
forward
parameter in the List Groups endpoint is used for permission checking. Iffalse
, it checks for the "AGENT_TO_AGENT_CALL" permission. -
The
quick
parameter in the List Groups endpoint, when set totrue
, returns a quicker response with potentially less detailed information. -
When filtering groups by name, the search is case-insensitive.
-
Group names are unique per user. If a duplicate name is provided, a number will be appended to make it unique.
-
When a group is deleted, all associated agent-group relations are also removed, and the group is removed from the agent profiles in Elasticsearch.
Delete
Endpoint Details
- Method: POST
-
Path:
deepcall/api/v2/Group/delete/
Description
This API endpoint allows users to delete an existing group from the system. It requires proper authentication either through a session ID (ssid) or a combination of userId and token.
Request Body Parameters
Field | Type | Required | Description |
---|---|---|---|
ssid | string | Yes (if userId and token not provided) | Session ID for authentication |
userId | string | Yes (if ssid not provided) | User ID for authentication |
token | string | Yes (if ssid not provided) | Token for authentication |
groupId | string | Yes | ID of the group to be deleted |
Response Parameters
Field | Type | Description |
---|---|---|
status | string | "success" if the operation was successful |
message | string | A message indicating the result of the operation |
code | number | HTTP status code (200 for success) |
Authentication Methods
1. Using Session ID (SSID)
- Provide the valid ssid for authentication
- Example:
Field Value ssid abc123xyz groupId 1
2. Using User ID and Token
- Provide both userId and token for authentication
- Example:
Field Value userId user123 token auth_token_xyz groupId 2
Important Notes
- Authentication is mandatory using either ssid OR userId+token combination
- The groupId parameter is required for successful deletion
- Missing or invalid parameters will result in an error response
- Only authorized users can delete groups
- The deletion operation is permanent and cannot be undone
- System will verify group ownership/permissions before deletion
Error Cases
Invalid Request Example (Missing groupId)
Field | Value |
---|---|
ssid | abc123xyz |
groupId | missing |
Other Error Cases
- Invalid authentication credentials
- Non-existent groupId
- Insufficient permissions to delete the group
This API ensures secure deletion of groups while maintaining proper authentication and authorization checks.
Delete
var axios = require('axios');
var data = '{"ssid":"{{ssid}}","groupId":11}';
var config = {
method: 'post',
url: '{{brand}}/api/v2/Group/delete',
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/Group/delete');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Length' => ''
));
$request->setBody('{"ssid":"{{ssid}}","groupId":11}');
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}}\",\"groupId\":11}"
headers = {
'Content-Length': ''
}
conn.request("POST", "/api/v2/Group/delete", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
var client = new RestClient("{{brand}}/api/v2/Group/delete");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
var body = @"{" + "\n" +
@" ""ssid"":""{{ssid}}""," + "\n" +
@" ""groupId"":11" + "\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/Group/delete' \
--data-raw '{
"ssid":"{{ssid}}",
"groupId":11
}'
var request = http.Request('POST', Uri.parse('{{brand}}/api/v2/Group/delete'));
request.body = '''{\n "ssid":"{{ssid}}",\n "groupId":11\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/Group/delete"
method := "POST"
payload := strings.NewReader(`{
"ssid":"{{ssid}}",
"groupId":11
}`)
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/Group/delete HTTP/1.1
Host: {{brand}}
Content-Length: 43
{
"ssid":"{{ssid}}",
"groupId":11
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "{\n \"ssid\":\"{{ssid}}\",\n \"groupId\":11\n}");
Request request = new Request.Builder()
.url("{{brand}}/api/v2/Group/delete")
.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 \"groupId\":11\n}";
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("{{brand}}/api/v2/Group/delete", 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/Group/delete");
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 \"groupId\":11\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/Group/delete"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
NSDictionary *headers = @{
@"Content-Length": @""
};
[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n \"ssid\":\"{{ssid}}\",\n \"groupId\":11\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 \"groupId\":11\n}";;
let reqBody =
let uri = Uri.of_string "%7B%7Bbrand%7D%7D/api/v2/Group/delete" 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 `"groupId`":11`n}"
$response = Invoke-RestMethod '{{brand}}/api/v2/Group/delete' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json
require "uri"
require "net/http"
url = URI("{{brand}}/api/v2/Group/delete")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Length"] = ""
request.body = "{\n \"ssid\":\"{{ssid}}\",\n \"groupId\":11\n}"
response = http.request(request)
puts response.read_body
printf '{
"ssid":"{{ssid}}",
"groupId":11
}'| http --follow --timeout 3600 POST '{{brand}}/api/v2/Group/delete' \
Content-Length:
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
var semaphore = DispatchSemaphore (value: 0)
let parameters = "{\n \"ssid\":\"{{ssid}}\",\n \"groupId\":11\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{brand}}/api/v2/Group/delete")!,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
10 Oct 2024 12:40:23 GMT"}
{"key":"Content-Type"
"value":"application\/json; charset=utf-8"}
{"key":"Content-Length"
"value":"76"}
{"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\/\"4c-NPYF\/X9RCfqFKM8JRMDMFL\/86Sk\""}
{"key":"Strict-Transport-Security"
"value":"max-age=15724800; includeSubDomains"}]
{
"status": "error",
"message": "Group not found or not authorized",
"code": 1503
}