Roles

List roles

List a collection of roles.

GEThttp://127.0.0.1:8888/api/roles

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/roles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "name": "User",
      "description": "text"
    }
  ]
}

Create a role

Create a new role.

POSThttp://127.0.0.1:8888/api/roles

Body

application/json

name*string

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: "User"

permissions*object

The permission list of role.

descriptionstring

Role's description.

Response

2014XX

OK

Body

application/json

namestring

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: "User"

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/roles', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "User",
      "permissions": {}
    }),
});
const data = await response.json();

Response

201

{
  "name": "User"
}

Retrieve a role

Retrieves the settings of a role.

GEThttp://127.0.0.1:8888/api/roles/{name}

Path parameters

name*string

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: "User"

Response

2004XX

OK

Body

application/json

namestring

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: "User"

permissionsobject

The permission list of role.

descriptionstring

Role's description.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/roles/{name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "name": "User",
  "permissions": {
    "general": {
      "voicemail_view_only": false,
      "voicemail_full_access": false,
      "meeting": false
    },
    "system": {
      "information": false,
      "dealer": false,
      "tenant": false
    },
    "trunk": {
      "view_only": false,
      "full_access": false
    },
    "company": {
      "view_only": false,
      "full_access": false
    },
    "company_call_log": {
      "call_log_view_only": false,
      "call_log_full_access": false,
      "call_recording_view_only": false,
      "call_recording_full_access": false
    },
    "phone_system": {
      "view_only": false,
      "full_access": false
    },
    "user_management": {
      "roles": false,
      "users": false
    },
    "user_call_log": {
      "call_log_view_only": false,
      "call_log_full_access": false,
      "call_recording_view_only": false,
      "call_recording_full_access": false
    },
    "policies": {
      "domestic_calls": false,
      "internal_calls": false,
      "international_calls": false
    },
    "analytics": {
      "call_report_view_only": false,
      "call_report_full_access": false
    },
    "billing": {
      "view_only": false,
      "full_access": false
    }
  },
  "description": "text"
}

Update a role

Modify the settings of a role.

POSThttp://127.0.0.1:8888/api/roles/{name}

Path parameters

name*string

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: "User"

Body

application/json

namestring

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: "User"

permissionsobject

The permission list of role.

descriptionstring

Role's description.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/roles/{name}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();