Team API

The Team API provides comprehensive team management functionality including team creation, member assignment, and call blending configuration for optimal resource allocation.


Get All Teams

GET /Advanced Dialer/api/team

Retrieves all teams with optional filtering by object types and member status.

Query Parameters

ParameterTypeDescription
objectTypesstringOptional filter for specific object types (e.g., 1,2).
showInactivebooleanSet to true to include inactive teams in the results.

Example Request

curl --request GET \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/team?objectTypes=1,2&showInactive=false' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY'

Response Example

{
  "statusCode": 0,
  "message": null,
  "payload": [
    {
      "teamId": 1,
      "name": "Sales Team Alpha",
      "description": "Primary sales team for North America",
      "userIds": [1001, 1002, 1003],
      "blenderSettings": {
        "entireTeamInbound": true,
        "maxInboundAgents": 2,
        "rotate": true,
        "targetFreeAgents": 1
      }
    }
  ]
}

Create Team

POST /Advanced Dialer/api/team

Creates a new team with specified members and blender settings.

Request Body

{
  "name": "Customer Success Team",
  "description": "Dedicated customer success and retention team",
  "userIds": [2001, 2002, 2003, 2004],
  "listIds": [201, 202],
  "blenderSettings": {
    "entireTeamInbound": true,
    "maxInboundAgents": 3,
    "rotate": true,
    "targetFreeAgents": 2
  }
}

Update Blender Settings

PATCH /Advanced Dialer/api/team/blending/{teamId}

Updates call blending configuration for optimal inbound/outbound call distribution.

Path Parameters

ParameterTypeDescription
teamIdintegerThe unique identifier of the team to update.

Example Request

curl --request PATCH \
     --url 'https://api.talkdeskapp.com/Advanced Dialer/api/team/blending/1' \
     --header 'Content-Type: application/json' \
     --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
     --data '{
  "entireTeamInbound": false,
  "inboundOnly": false,
  "maxInboundAgents": 3,
  "outboundOnly": false,
  "rotate": true,
  "targetFreeAgents": 2
}'

Move Team Members

PUT /Advanced Dialer/api/team/members

Moves or copies agents between teams.

Request Body

FieldTypeDescription
fromintegerThe source team ID.
tointegerThe destination team ID.
agentIdsarrayList of agent IDs to transfer.
modestringOperation type: Move or Copy.
{
  "from": 1,
  "to": 5,
  "agentIds": [1001, 1002],
  "mode": "Move"
}