V 2.0
Agent
Introduction
This document provides detailed information about the API endpoints available in the Agent.js file. It includes request parameters, response formats, and examples for each endpoint.
Base URL
The base URL for all API endpoints is: deepcall/api/v2/Agent
Authentication
Authentication is required for all endpoints. It can be done in two ways:
-
Using
ssid
(Session ID) -
Using
userId
andtoken
Note: When userId
and token
are used, ssid
should not be present in the request.
Error Codes
Error Code | Description |
---|---|
1501 | Data already in processing |
1502 | Invalid filter value |
1503 | Invalid role id |
1504 | Invalid parent |
1505 | Invalid group data |
1506 | AgentId and parent could not be same |
1507 | Invalid AgentID |
1508 | Invalid status value |
1509 | Invalid agentId |
1510 | Invalid Destination |
1511 | Working time format is invalid |
1512 | Email already exists |
1513 | Invalid type |
1514 | Invalid mobile Number |
1515 | Invalid Name |
1516 | Invalid Did Number |
1517 | Your agentid and your loginid must be same |
1518 | Data could not be updated |
1519 | Call Password must be Integer and Eight digit |
1520 | You must be single field update |
1521 | Please Provide Only Valid fields |
1522 | You could not inserted your data. Please try again |
1523 | Your agent information is already added |
1524 | Invalid Action |
1525 | Invalid Targetagent Id |
1526 | Invalid Id |
1527 | Invalid Type |
1528 | Invalid Favorite Data |
1529 | Invalid Domain |
1530 | Invalid Agent Timing |
Update Agent Group Mapping
Endpoint
- Method: POST
-
Path:
deepcall/api/v2/Agent/updateAgentGroupMapping/
Description
The Update Agent Group Mapping endpoint allows you to modify the group assignments for an existing agent in the system. This endpoint is used to update which groups an agent belongs to and whether they can receive calls for each group. It provides a way to manage agent-group relationships and control call routing based on these assignments.
Use Cases
- Assigning an agent to new groups
- Removing an agent from groups
- Updating an agent's call receiving status for specific groups
- Reorganizing agent-group structures
Request Details
Parameter | Type | Required | Description |
---|---|---|---|
ssid | string | No | Session ID (required if token is not used) |
userId | string | No | User ID (required if ssid is not used) |
token | string | No | Authentication token (required if ssid is not used) |
agentId | string | Yes | The ID of the agent to update |
group | object | Yes | Group mapping data with receive_call status |
Response Details
Success Response Structure
Field | Type | Description |
---|---|---|
status | string | Response status ("success") |
code | number | Response code (200 for success) |
message | string | Success message |
Error Response Examples
Error Code | Description | Message |
---|---|---|
1509 | Invalid AgentID | Invalid agentId |
1505 | Invalid Group Data | Invalid group data |
1015 | Permission Denied | Permission denied |
Notes
- The
group
object in the request should contain:- Group IDs as keys
- Objects with a
receive_call
property ("Y" or "N") as values
- Any groups not included in the request will not be modified
- This endpoint will overwrite existing group mappings for the specified groups
- To retain existing mappings, include them in the request
- Ensure that the agent and all group IDs exist in the system
- The user making the request must have the necessary permissions
Update Agent Group Mapping
var axios = require('axios');
var data = '{"userId": "{{userid}}","token":"{{token}}","agentId": "7","group": {"90": {"receive_call": "Y"},"91": {"receive_call": "N"},"92": {"receive_call": "Y"}}}';
var config = {
method: 'post',
url: '{{brand}}/api/v2/Agent/updateAgentGroupMapping',
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/Agent/updateAgentGroupMapping');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Length' => ''
));
$request->setBody('{"userId": "{{userid}}","token":"{{token}}","agentId": "7","group": {"90": {"receive_call": "Y"},"91": {"receive_call": "N"},"92": {"receive_call": "Y"}}}');
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}}\",\"agentId\": \"7\",\"group\": {\"90\": {\"receive_call\": \"Y\"},\"91\": {\"receive_call\": \"N\"},\"92\": {\"receive_call\": \"Y\"}}}"
headers = {
'Content-Length': ''
}
conn.request("POST", "/api/v2/Agent/updateAgentGroupMapping", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
var client = new RestClient("{{brand}}/api/v2/Agent/updateAgentGroupMapping");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
var body = @"{" + "\n" +
@" ""userId"": ""{{userid}}""," + "\n" +
@" ""token"":""{{token}}""," + "\n" +
@" ""agentId"": ""7""," + "\n" +
@" ""group"": {" + "\n" +
@" ""90"": {" + "\n" +
@" ""receive_call"": ""Y""" + "\n" +
@" }," + "\n" +
@" ""91"": {" + "\n" +
@" ""receive_call"": ""N""" + "\n" +
@" }," + "\n" +
@" ""92"": {" + "\n" +
@" ""receive_call"": ""Y""" + "\n" +
@" }" + "\n" +
@" }" + "\n" +
@"}" + "\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/Agent/updateAgentGroupMapping' \
--data-raw '{
"userId": "{{userid}}",
"token":"{{token}}",
"agentId": "7",
"group": {
"90": {
"receive_call": "Y"
},
"91": {
"receive_call": "N"
},
"92": {
"receive_call": "Y"
}
}
}'
var request = http.Request('POST', Uri.parse('{{brand}}/api/v2/Agent/updateAgentGroupMapping'));
request.body = '''{\n "userId": "{{userid}}",\n "token":"{{token}}",\n "agentId": "7",\n "group": {\n "90": {\n "receive_call": "Y"\n },\n "91": {\n "receive_call": "N"\n },\n "92": {\n "receive_call": "Y"\n }\n }\n}\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/Agent/updateAgentGroupMapping"
method := "POST"
payload := strings.NewReader(`{
"userId": "{{userid}}",
"token":"{{token}}",
"agentId": "7",
"group": {
"90": {
"receive_call": "Y"
},
"91": {
"receive_call": "N"
},
"92": {
"receive_call": "Y"
}
}
}`)
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/Agent/updateAgentGroupMapping HTTP/1.1
Host: {{brand}}
Content-Length: 221
{
"userId": "{{userid}}",
"token":"{{token}}",
"agentId": "7",
"group": {
"90": {
"receive_call": "Y"
},
"91": {
"receive_call": "N"
},
"92": {
"receive_call": "Y"
}
}
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "{\n \"userId\": \"{{userid}}\",\n \"token\":\"{{token}}\",\n \"agentId\": \"7\",\n \"group\": {\n \"90\": {\n \"receive_call\": \"Y\"\n },\n \"91\": {\n \"receive_call\": \"N\"\n },\n \"92\": {\n \"receive_call\": \"Y\"\n }\n }\n}\n");
Request request = new Request.Builder()
.url("{{brand}}/api/v2/Agent/updateAgentGroupMapping")
.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 \"agentId\": \"7\",\n \"group\": {\n \"90\": {\n \"receive_call\": \"Y\"\n },\n \"91\": {\n \"receive_call\": \"N\"\n },\n \"92\": {\n \"receive_call\": \"Y\"\n }\n }\n}\n";
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("{{brand}}/api/v2/Agent/updateAgentGroupMapping", 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/Agent/updateAgentGroupMapping");
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 \"agentId\": \"7\",\n \"group\": {\n \"90\": {\n \"receive_call\": \"Y\"\n },\n \"91\": {\n \"receive_call\": \"N\"\n },\n \"92\": {\n \"receive_call\": \"Y\"\n }\n }\n}\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/Agent/updateAgentGroupMapping"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
NSDictionary *headers = @{
@"Content-Length": @""
};
[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n \"userId\": \"{{userid}}\",\n \"token\":\"{{token}}\",\n \"agentId\": \"7\",\n \"group\": {\n \"90\": {\n \"receive_call\": \"Y\"\n },\n \"91\": {\n \"receive_call\": \"N\"\n },\n \"92\": {\n \"receive_call\": \"Y\"\n }\n }\n}\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 \"agentId\": \"7\",\n \"group\": {\n \"90\": {\n \"receive_call\": \"Y\"\n },\n \"91\": {\n \"receive_call\": \"N\"\n },\n \"92\": {\n \"receive_call\": \"Y\"\n }\n }\n}";;
let reqBody =
let uri = Uri.of_string "%7B%7Bbrand%7D%7D/api/v2/Agent/updateAgentGroupMapping" 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 `"agentId`": `"7`",`n `"group`": {`n `"90`": {`n `"receive_call`": `"Y`"`n },`n `"91`": {`n `"receive_call`": `"N`"`n },`n `"92`": {`n `"receive_call`": `"Y`"`n }`n }`n}`n"
$response = Invoke-RestMethod '{{brand}}/api/v2/Agent/updateAgentGroupMapping' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json
require "uri"
require "net/http"
url = URI("{{brand}}/api/v2/Agent/updateAgentGroupMapping")
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 \"agentId\": \"7\",\n \"group\": {\n \"90\": {\n \"receive_call\": \"Y\"\n },\n \"91\": {\n \"receive_call\": \"N\"\n },\n \"92\": {\n \"receive_call\": \"Y\"\n }\n }\n}"
response = http.request(request)
puts response.read_body
printf '{
"userId": "{{userid}}",
"token":"{{token}}",
"agentId": "7",
"group": {
"90": {
"receive_call": "Y"
},
"91": {
"receive_call": "N"
},
"92": {
"receive_call": "Y"
}
}
}
'| http --follow --timeout 3600 POST '{{brand}}/api/v2/Agent/updateAgentGroupMapping' \
Content-Length:
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
var semaphore = DispatchSemaphore (value: 0)
let parameters = "{\n \"userId\": \"{{userid}}\",\n \"token\":\"{{token}}\",\n \"agentId\": \"7\",\n \"group\": {\n \"90\": {\n \"receive_call\": \"Y\"\n },\n \"91\": {\n \"receive_call\": \"N\"\n },\n \"92\": {\n \"receive_call\": \"Y\"\n }\n }\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{brand}}/api/v2/Agent/updateAgentGroupMapping")!,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:58:11 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-pSrtaoek7bATDVxUhKpKMDE6hUw\""}
{"key":"Strict-Transport-Security"
"value":"max-age=15724800; includeSubDomains"}]
{
"status": "error",
"message": "Permission denied",
"code": 1015
}