Agent Permissions Management

Agent Permissions Management

Manage agent access levels by retrieving permitted applications or updating the list of applications an agent is authorized to use.


Get Agent Applications

GET /Advanced Dialer/api/agent/{userId}/permissions/applications

Returns a list of applications that the specified agent is permitted to access.

Path Parameters

ParameterTypeDescription
userIdintegerThe unique identifier of the agent.

Example Request

curl --request GET \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/agent/1001/permissions/applications' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
     --header 'X-Api-Version: 2.0'

Response Example

{
  "statusCode": 0,
  "message": null,
  "payload": [
    {
      "id": 1,
      "name": "Synthesys CRM"
    },
    {
      "id": 2,
      "name": "Campaign Manager"
    },
    {
      "id": 3,
      "name": "Reporting Suite"
    }
  ]
}

Update Agent Applications

PUT /Advanced Dialer/api/agent/{userId}/permissions/applications

Sets the application permissions for an agent. Note that this typically replaces the existing permission set with the one provided in the request body.

Path Parameters

ParameterTypeDescription
userIdintegerThe unique identifier of the agent.

Request Body (Array)

FieldTypeDescription
idintegerThe unique ID of the application.
namestringThe name of the application.

Example Request

curl --request PUT \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/agent/1001/permissions/applications' \
     --header 'Content-Type: application/json' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
     --header 'X-Api-Version: 2.0' \
     --data '[
  {
    "id": 1,
    "name": "Synthesys CRM"
  },
  {
    "id": 4,
    "name": "Quality Management"
  }
]'