V 2.0
Role
Overview
The Role provides endpoints to manage user roles within the system. It enables operations such as creating, updating, and listing roles with their associated permissions.
Key Features:
-
Role Management:
- Create new roles with specific permissions
- Update existing role properties
- List all roles with pagination support
- Filter roles based on status and custom parameters
-
Authentication:
- Supports session-based authentication (SSID)
- Supports token-based authentication
- Role-based access control
-
Access Control:
- Visibility settings for roles
- Status management (active/inactive)
- User-specific role assignments
Add
{{brand}}/api/v2/role/add
Endpoint
-
Method:
POST
-
Path:
deepcall/api/v2/role/add/
Description
This endpoint allows users to add a new role in the system. The role is assigned a unique identifier and stored in the database.
Use Case
- Creating new roles within the system.
- Assigning roles to users for access control.
- Managing user roles dynamically.
Request Parameters
Name | Type | Required | Description |
---|---|---|---|
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) |
name |
String |
Yes | Name of the role to be created |
Role Creation Logic
- The system validates the request parameters.
- It checks authentication using either
ssid
oruserId
&token
. - If valid, it generates a unique ID for the role using a sequence counter.
- The role is added to the
user_role
collection with default values:-
status: 1
(Active) -
can_see: 0
-
create_date
(Unix timestamp) -
create_by
(User ID) -
create_by_type
(Login type)
-
- The role is also updated in the local
user_role
cache.
Add
var axios = require('axios');
var data = '{"ssid":"{{ssid}}","name":"First Role"}';
var config = {
method: 'post',
url: '{{brand}}/api/v2/role/add',
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/role/add');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Length' => ''
));
$request->setBody('{"ssid":"{{ssid}}","name":"First Role"}');
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}}\",\"name\":\"First Role\"}"
headers = {
'Content-Length': ''
}
conn.request("POST", "/api/v2/role/add", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
var client = new RestClient("{{brand}}/api/v2/role/add");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
var body = @"{" + "\n" +
@" ""ssid"":""{{ssid}}""," + "\n" +
@" ""name"":""First Role""" + "\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/role/add' \
--data-raw '{
"ssid":"{{ssid}}",
"name":"First Role"
}'
var request = http.Request('POST', Uri.parse('{{brand}}/api/v2/role/add'));
request.body = '''{\n "ssid":"{{ssid}}",\n "name":"First Role"\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/role/add"
method := "POST"
payload := strings.NewReader(`{
"ssid":"{{ssid}}",
"name":"First Role"
}`)
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/role/add HTTP/1.1
Host: {{brand}}
Content-Length: 50
{
"ssid":"{{ssid}}",
"name":"First Role"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "{\n \"ssid\":\"{{ssid}}\",\n \"name\":\"First Role\"\n}");
Request request = new Request.Builder()
.url("{{brand}}/api/v2/role/add")
.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 \"name\":\"First Role\"\n}";
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("{{brand}}/api/v2/role/add", 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/role/add");
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 \"name\":\"First Role\"\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/role/add"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
NSDictionary *headers = @{
@"Content-Length": @""
};
[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n \"ssid\":\"{{ssid}}\",\n \"name\":\"First Role\"\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 \"name\":\"First Role\"\n}";;
let reqBody =
let uri = Uri.of_string "%7B%7Bbrand%7D%7D/api/v2/role/add" 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 `"name`":`"First Role`"`n}"
$response = Invoke-RestMethod '{{brand}}/api/v2/role/add' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json
require "uri"
require "net/http"
url = URI("{{brand}}/api/v2/role/add")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Length"] = ""
request.body = "{\n \"ssid\":\"{{ssid}}\",\n \"name\":\"First Role\"\n}"
response = http.request(request)
puts response.read_body
printf '{
"ssid":"{{ssid}}",
"name":"First Role"
}'| http --follow --timeout 3600 POST '{{brand}}/api/v2/role/add' \
Content-Length:
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
var semaphore = DispatchSemaphore (value: 0)
let parameters = "{\n \"ssid\":\"{{ssid}}\",\n \"name\":\"First Role\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{brand}}/api/v2/role/add")!,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":"Wed
29 Jan 2025 12:30:11 GMT"}
{"key":"Content-Type"
"value":"application\/json; charset=utf-8"}
{"key":"Content-Length"
"value":"326"}
{"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\/\"146-imoIt2SoQOrUY5beqPDwP98065I\""}
{"key":"Strict-Transport-Security"
"value":"max-age=15724800; includeSubDomains"}]
{
"message": "Role added successfully.",
"newRole": {
"unique_id": 27,
"user_id": "29791451",
"name": "First Role",
"status": 1,
"can_see": 0,
"create_date": 1738153811,
"create_by": "29791451",
"create_by_type": "client",
"packageInfo": {
"bServer": 4,
"panel": 1,
"queue": 6
},
"_id": "679a1f53a9e2d0235b86c4b5",
"agCount": 0
},
"status": "success",
"code": 200
}