TeamResponseDTO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TeamResponseDTO",
  "title": "TeamResponseDTO",
  "type": "object",
  "properties": {
    "organizationId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the contact center organization. This field is required for all bulk save operations.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
      "maxLength": 36,
      "minLength": 32,
      "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
    },
    "id": {
      "type": "string",
      "description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
      "example": "93912f11-6017-404b-bf14-5331890b1797"
    },
    "version": {
      "type": "integer",
      "format": "int32",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "example": 1
    },
    "name": {
      "type": "string",
      "description": "Indicates the name of the team such as Billing or Customer Support",
      "example": "Customer Support"
    },
    "teamType": {
      "type": "string",
      "description": "Team type can be the following:\n\nAGENT: A specific number of agents are assigned to the team.\n\nCAPACITY: Specific number of agents not assigned to the team. Capacity-based teams for voice mailboxes or agent groups that are not managed by the Webex Contact Center system.",
      "enum": [
        "AGENT",
        "CAPACITY"
      ],
      "example": "AGENT"
    },
    "teamStatus": {
      "type": "string",
      "description": "Indicates whether the team is available to handle customer contacts.\nCan be one of: IN_SERVICE/NOT_AVAILABLE.\n",
      "enum": [
        "IN_SERVICE",
        "NOT_AVAILABLE"
      ],
      "example": "IN_SERVICE"
    },
    "dialedNumber": {
      "type": "string",
      "description": "The dial number where the system distributes the calls for this team. \nThis setting is applicable only for capacity-based teams.",
      "example": "+14085550123"
    },
    "capacity": {
      "type": "integer",
      "format": "int32",
      "description": "The maximum number of simultaneous contacts that this team can handle.\nThis setting is applicable only for capacity-based teams.",
      "example": 1
    },
    "active": {
      "type": "boolean",
      "description": "Indicates whether the team is active(when true) or not active(when false).",
      "example": true
    },
    "siteId": {
      "type": "string",
      "description": "Identifier for a site which is a physical contact center location under the control of your enterprise.",
      "example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
    },
    "desktopLayoutId": {
      "type": "string",
      "description": "Identifier for an agent desktop layout which  a Contact Center administrator has configured.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "siteName": {
      "type": "string",
      "description": "The name of the site this team belongs to.",
      "example": "New_York"
    },
    "skillProfileId": {
      "type": "string",
      "description": "Id of the skill profile for this team if your enterprise uses the optional Skills-Based Routing feature.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "multiMediaProfileId": {
      "type": "string",
      "description": "Id of the multimedia profile for this team.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "userIds": {
      "type": "array",
      "description": "Indicates the agents id(s) who are part of this team.",
      "example": [
        "f53c8b54-46ca-43f6-ba05-08426a46e23d",
        "a53c8b54-46ca-43f6-ba05-08426a46e23f"
      ],
      "items": {
        "type": "string",
        "description": "Indicates the agents id(s) who are part of this team.",
        "example": [
          "f53c8b54-46ca-43f6-ba05-08426a46e23d",
          "a53c8b54-46ca-43f6-ba05-08426a46e23f"
        ]
      },
      "uniqueItems": true
    },
    "description": {
      "type": "string",
      "description": "Indicates the team",
      "example": "Capacity based team"
    },
    "systemDefault": {
      "type": "boolean",
      "description": "Indicates whether the created resource is system created or not",
      "example": false
    },
    "rankQueuesForTeam": {
      "type": "boolean"
    },
    "queueRankings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/QueueRankingDTO"
      },
      "uniqueItems": true
    },
    "createdTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the created time of the entity."
    },
    "lastUpdatedTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the updated time of the entity."
    }
  }
}