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.
Group Agent Relation
Endpoint Details
- Method: POST
-
Path:
deepcall/api/v2/Group/getGroupAgentRelation/
Description
This API endpoint retrieves agent relations for a specific group. It returns group data, agent data, and the relationships between them. The endpoint requires 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 fetch relations for |
quick | boolean | No | If true, returns complete data. Default is false |
name | string | No | Filter results by group name |
Response Parameters
Field | Type | Description |
---|---|---|
status | string | "success" if the operation was successful |
response | object | Contains groupData, agentData, and relationData |
code | number | HTTP status code (200 for success) |
Example Request 1 - Using SSID
Field | Value |
---|---|
ssid | abc123xyz |
groupId | 1 |
quick | true |
Example Request 2 - Using userId and token
Field | Value |
---|---|
userId | user123 |
token | auth_token_xyz |
groupId | 1 |
quick | true |
Response Data Structure
GroupData
Field | Value |
---|---|
name | Sales Team |
user_id | user123 |
create_date | 1679529600 |
unique_id | 1 |
agents | ["#1001 John Doe", "#1002 Jane Smith"] |
AgentData
Name | Unique ID | User ID |
---|---|---|
John Doe | 1001 | user123 |
Jane Smith | 1002 | user123 |
RelationData
Group ID | Agent ID | User ID | Receive Call |
---|---|---|---|
1 | 1001 | user123 | Y |
1 | 1002 | user123 | N |
Error Codes
Code | Description |
---|---|
1000 | Invalid parameters |
1502 | Group ID not provided |
1503 | Group not found or not authorized |
1015 | Permission denied |
1009 | Something went wrong (Generic error) |
Important Notes
Authentication:
- Mandatory: Must provide either ssid OR userId+token combination
- Permission: Requires 'AGENT_TO_AGENT_CALL' permission
Request Parameters:
- Quick Parameter: Must be set to true to receive data
- Name Filter: Case-insensitive search for group names
Response Data:
- Group Details: Includes complete group information and associated agents
- Agent Information: Contains all agent details in the group
- Relationship Data: Shows agent-group associations and call permissions
Group Agent Relation
var axios = require('axios');
var data = '{"userId": "{{userid}}","token":"{{token}}","quick":true,"groupId":28}';
var config = {
method: 'post',
url: '{{brand}}/api/v2/Group/getGroupAgentRelation',
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/getGroupAgentRelation');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Length' => ''
));
$request->setBody('{"userId": "{{userid}}","token":"{{token}}","quick":true,"groupId":28}');
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 = "{\"userId\": \"{{userid}}\",\"token\":\"{{token}}\",\"quick\":true,\"groupId\":28}"
headers = {
'Content-Length': ''
}
conn.request("POST", "/api/v2/Group/getGroupAgentRelation", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
var client = new RestClient("{{brand}}/api/v2/Group/getGroupAgentRelation");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
var body = @"{" + "\n" +
@" ""userId"": ""{{userid}}""," + "\n" +
@" ""token"":""{{token}}""," + "\n" +
@" ""quick"":true," + "\n" +
@" ""groupId"":28" + "\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/getGroupAgentRelation' \
--data-raw '{
"userId": "{{userid}}",
"token":"{{token}}",
"quick":true,
"groupId":28
}'
var request = http.Request('POST', Uri.parse('{{brand}}/api/v2/Group/getGroupAgentRelation'));
request.body = '''{\n "userId": "{{userid}}",\n "token":"{{token}}",\n "quick":true,\n "groupId":28\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/getGroupAgentRelation"
method := "POST"
payload := strings.NewReader(`{
"userId": "{{userid}}",
"token":"{{token}}",
"quick":true,
"groupId":28
}`)
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/getGroupAgentRelation HTTP/1.1
Host: {{brand}}
Content-Length: 91
{
"userId": "{{userid}}",
"token":"{{token}}",
"quick":true,
"groupId":28
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "{\n \"userId\": \"{{userid}}\",\n \"token\":\"{{token}}\",\n \"quick\":true,\n \"groupId\":28\n}");
Request request = new Request.Builder()
.url("{{brand}}/api/v2/Group/getGroupAgentRelation")
.method("POST", body)
.addHeader("Content-Length", "")
.build();
Response response = client.newCall(request).execute();
var myHeaders = new Headers();
myHeaders.append("Content-Length", "");
var raw = "{\n \"userId\": \"{{userid}}\",\n \"token\":\"{{token}}\",\n \"quick\":true,\n \"groupId\":28\n}";
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("{{brand}}/api/v2/Group/getGroupAgentRelation", 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/getGroupAgentRelation");
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 \"userId\": \"{{userid}}\",\n \"token\":\"{{token}}\",\n \"quick\":true,\n \"groupId\":28\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/getGroupAgentRelation"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
NSDictionary *headers = @{
@"Content-Length": @""
};
[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n \"userId\": \"{{userid}}\",\n \"token\":\"{{token}}\",\n \"quick\":true,\n \"groupId\":28\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 \"userId\": \"{{userid}}\",\n \"token\":\"{{token}}\",\n \"quick\":true,\n \"groupId\":28\n}";;
let reqBody =
let uri = Uri.of_string "%7B%7Bbrand%7D%7D/api/v2/Group/getGroupAgentRelation" 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 `"userId`": `"{{userid}}`",`n `"token`":`"{{token}}`",`n `"quick`":true,`n `"groupId`":28`n}"
$response = Invoke-RestMethod '{{brand}}/api/v2/Group/getGroupAgentRelation' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json
require "uri"
require "net/http"
url = URI("{{brand}}/api/v2/Group/getGroupAgentRelation")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Length"] = ""
request.body = "{\n \"userId\": \"{{userid}}\",\n \"token\":\"{{token}}\",\n \"quick\":true,\n \"groupId\":28\n}"
response = http.request(request)
puts response.read_body
printf '{
"userId": "{{userid}}",
"token":"{{token}}",
"quick":true,
"groupId":28
}'| http --follow --timeout 3600 POST '{{brand}}/api/v2/Group/getGroupAgentRelation' \
Content-Length:
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
var semaphore = DispatchSemaphore (value: 0)
let parameters = "{\n \"userId\": \"{{userid}}\",\n \"token\":\"{{token}}\",\n \"quick\":true,\n \"groupId\":28\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{brand}}/api/v2/Group/getGroupAgentRelation")!,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":"Sat
16 Nov 2024 14:13:04 GMT"}
{"key":"Content-Type"
"value":"application\/json; charset=utf-8"}
{"key":"Content-Length"
"value":"1084"}
{"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\/\"43c-S+YquNY6KrweMo\/TBl2XVS1tyZE\""}
{"key":"Strict-Transport-Security"
"value":"max-age=15724800; includeSubDomains"}]
{
"status": "success",
"response": {
"groupData": {
"name": "Mahipal singh",
"user_id": "29791451",
"create_by": "29791451",
"unique_id": 28,
"status": 1,
"create_date": 1731746318,
"agents": [
"#3 bhawesh",
"#8 manoj",
"#2 bhawesh"
]
},
"agentData": [
{
"name": "bhawesh",
"unique_id": 1,
"user_id": "29791451"
},
{
"name": "bhawesh",
"unique_id": 2,
"user_id": "29791451"
},
{
"name": "Bhawna",
"unique_id": 6,
"user_id": "29791451"
},
{
"name": "Sumit",
"unique_id": 9,
"user_id": "29791451"
},
{
"name": "bhawesh",
"unique_id": 3,
"user_id": "29791451"
},
{
"name": "Brijendra",
"unique_id": 5,
"user_id": "29791451"
},
{
"name": "Manoj Kumar111",
"unique_id": 10,
"user_id": "29791451"
},
{
"name": "vijay developer",
"unique_id": 4,
"user_id": "29791451"
},
{
"name": "Manoj Kumar111",
"unique_id": 7,
"user_id": "29791451"
},
{
"name": "manoj",
"unique_id": 8,
"user_id": "29791451"
},
{
"name": "Manoj Kumar111",
"unique_id": 11,
"user_id": "29791451"
}
],
"relationData": [
{
"group_id": 28,
"agent_id": 3,
"receive_call": "Y",
"user_id": "29791451"
},
{
"group_id": 28,
"agent_id": 8,
"receive_call": "Y",
"user_id": "29791451"
},
{
"group_id": 28,
"agent_id": 2,
"receive_call": "Y",
"user_id": "29791451"
}
]
},
"code": 200
}