TeamDTO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TeamDTO",
  "title": "TeamDTO",
  "type": "object",
  "description": "Team resource used for create and update operations.",
  "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": "Enter the name for the team. Generally, use names that indicate the function of the team, such as Billing or Customer Support. This field should be specified for create and update operation. Two teams in the same site in an organization cannot share the same name.",
      "example": "inline-pcs-team"
    },
    "teamType": {
      "type": "string",
      "description": "Team type can be the following:\n\nAGENT: You assign a specific number of agents to the team.\n\nCAPACITY: You don\u2019t assign any specific number of agents to the team. You use capacity-based teams for voice mailboxes or agent groups that are not managed by the Webex Contact Center system.\n\nOnce created, teamType cannot be modified.",
      "enum": [
        "AGENT",
        "CAPACITY"
      ],
      "example": "AGENT"
    },
    "teamStatus": {
      "type": "string",
      "description": "Select the status of the team to indicate whether the team is available to handle customer contacts.\nCan be one of: IN_SERVICE/NOT_AVAILABLE.",
      "enum": [
        "IN_SERVICE",
        "NOT_AVAILABLE"
      ],
      "example": "IN_SERVICE"
    },
    "dialedNumber": {
      "type": "string",
      "description": "Enter 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": "Enter 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": "Specify whether the team is active or not Active.",
      "example": true
    },
    "siteId": {
      "type": "string",
      "description": "Identifier for a site which is a physical contact center location under the control of your enterprise. Once specified, siteId should not be modified.",
      "example": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
      "minLength": 1
    },
    "desktopLayoutId": {
      "type": "string",
      "description": "Identifier for an agent desktop layout which  a Contact Center administrator has configured.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "skillProfileId": {
      "type": "string",
      "description": "(Optional) If your enterprise uses the optional Skills-Based Routing feature, you can select a skill profile for this team. \nNote: You can\u2019t assign this profile to a capacity-based team.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "multiMediaProfileId": {
      "type": "string",
      "description": "(Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team. \nNote: You can\u2019t assign this profile to a capacity-based team.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "userIds": {
      "type": "array",
      "description": "Specify the agents id who will be part of this team. \nNote: You can\u2019t assign this profile to a capacity-based team.",
      "example": [
        "f53c8b54-46ca-43f6-ba05-08426a46e23d",
        "a53c8b54-46ca-43f6-ba05-08426a46e23f"
      ],
      "items": {
        "type": "string",
        "description": "Specify the agents id who will be part of this team. \nNote: You can\u2019t assign this profile to a capacity-based team.",
        "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
      },
      "uniqueItems": true
    },
    "description": {
      "type": "string",
      "description": "Description of the team.",
      "maxLength": 255,
      "minLength": 0
    },
    "systemDefault": {
      "type": "boolean",
      "description": "Indicates whether the created resource is system created or not",
      "example": false
    },
    "rankQueuesForTeam": {
      "type": "boolean",
      "description": "Indicates whether the queues should be ranked for the team.",
      "example": true
    },
    "queueRankings": {
      "type": "array",
      "description": "List of queue rankings associated with this team.",
      "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."
    }
  },
  "required": [
    "active",
    "name",
    "rankQueuesForTeam",
    "siteId",
    "teamStatus",
    "teamType"
  ]
}