User Management API (Enhanced)

The enhanced User Management API provides advanced user administration capabilities with comprehensive agent lifecycle management, Active Directory integration, and detailed permission controls.

Advanced Agent Management

GET /Advanced Dialer/api/usermanagement/v2/agents

Retrieves all agents with enhanced filtering and detail options, including role data and team assignments.

Example Request

curl --request GET \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/usermanagement/v2/agents' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
     --header 'X-Api-Version: 2.0'

Response Example

{
  "statusCode": 0,
  "message": null,
  "payload": [
    {
      "id": 1001,
      "username": "john.smith",
      "firstName": "John",
      "lastName": "Smith",
      "title": "Senior Agent",
      "isActive": true,
      "userInformation": {
        "passwordExpiry": "2024-12-31T23:59:59Z",
        "role": {
          "id": 2,
          "name": "Agent"
        },
        "teams": [
          {
            "id": 1,
            "name": "Sales Team Alpha"
          }
        ],
        "isActiveDirectory": false
      }
    }
  ]
}

Password Management

PATCH /Advanced Dialer/api/usermanagement/v2/agent/{agentId}/password

Generates and sets a new random temporary password for a specific agent.

Path Parameters

Parameter	Type	Description
`agentId`	integer	The unique identifier of the agent.

Example Request

curl --request PATCH \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/usermanagement/v2/agent/1001/password' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
     --header 'X-Api-Version: 2.0'

Active Directory Integration

These endpoints facilitate the synchronization and import of users from an external Active Directory.

Get AD Users

GET /Advanced Dialer/api/usermanagement/v2/adusers

Retrieves available Active Directory users eligible for import into the Advanced Dialer system.

Import AD Users

POST /Advanced Dialer/api/usermanagement/v2/adusers

Imports a batch of Active Directory users into the local system.

[
  {
    "username": "jane.doe",
    "firstName": "Jane",
    "surname": "Doe",
    "email": "[email protected]",
    "telephoneMobile": "+1-555-0123",
    "enabled": true,
    "role": "Agent"
  }
]

Skills Management

GET /Advanced Dialer/api/usermanagement/v2/skills

Retrieves all available skills in the system, including their current usage status.

Response Example

{
  "statusCode": 0,
  "message": null,
  "payload": [
    {
      "id": 1,
      "name": "Customer Service",
      "isInUse": true,
      "description": "General customer service skills"
    }
  ]
}

Team Management

GET /Advanced Dialer/api/usermanagement/v2/teams

Retrieves teams with permission-based filtering and call direction settings.

Response Example

{
  "statusCode": 0,
  "message": null,
  "payload": [
    {
      "name": "Sales Team Alpha",
      "id": 1,
      "callDirection": 2,
      "blenderSettings": {
        "inboundOnly": false,
        "outboundOnly": false
      }
    }
  ]
}