Skill API

The Skill API manages agent skills, skill conditions, and skill-based routing configurations for optimized call distribution based on agent capabilities.

Get All Skills

GET /Advanced Dialer/api/Skill

Retrieves all skills in the system with optional filtering and extended information.

Query Parameters

Parameter	Type	Description
`extend`	boolean	Set to `true` to return detailed metadata for each skill.

Example Request

curl --request GET \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/Skill?extend=true' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY'

Response Example

{
  "statusCode": 0,
  "message": null,
  "payload": [
    {
      "id": 1,
      "name": "Customer Service",
      "description": "General customer service and support skills"
    },
    {
      "id": 2,
      "name": "Technical Support",
      "description": "Advanced technical troubleshooting and support"
    }
  ]
}

Create Skill

POST /Advanced Dialer/api/Skill

Creates a new skill in the system.

Request Body

{
  "name": "Billing Support",
  "description": "Specialized billing inquiries and payment processing"
}

Response Example

{
  "statusCode": 0,
  "message": "Skill created successfully",
  "payload": {
    "id": 4,
    "name": "Billing Support"
  }
}

Manage Skill Conditions

POST /Advanced Dialer/api/Skill/condition

Creates skill-based routing conditions for campaigns and lists. This allows the system to route calls to agents based on their specific proficiency levels.

Request Body

Field	Type	Description
`skillId`	integer	The ID of the skill required for the condition.
`minimumAbility`	integer	The minimum proficiency score (0-100) required to handle the call.
`useAbilityRanking`	boolean	If true, the system prioritizes agents with higher ability scores.
`campaignId`	integer	The campaign to apply this routing condition to.
`level`	integer	The priority level of the skill requirement.

Example Request

curl --request POST \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/Skill/condition' \
     --header 'Content-Type: application/json' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
     --data '{
  "skillId": 1,
  "minimumAbility": 75,
  "useAbilityRanking": true,
  "mandatoryProfile": false,
  "campaignId": 101,
  "listId": 201,
  "level": 1
}'