{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/AgentProfileResponseDTO", "title": "AgentProfileResponseDTO", "required": [ "accessBuddyTeam", "accessEntryPoint", "accessIdleCode", "accessQueue", "accessWrapUpCode", "active", "agentDNValidation", "name", "parentType" ], "type": "object", "properties": { "organizationId": { "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}$", "type": "string", "description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations", "format": "uuid", "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d" }, "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", "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.", "format": "int32", "example": 1 }, "name": { "maxLength": 80, "minLength": 1, "pattern": "^[a-zA-Z0-9\\._\\s\\-\\(\\)]+$", "type": "string", "description": "Enter a name for the agent profile.", "example": "Agent-Profile(Auto WrapUp)" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "(Optional) Enter a description of the profile.", "example": "This profile allows agent to auto wrap-up time and extend the wrap-up time." }, "parentType": { "type": "string", "description": "This can be the following\n\nORGANIZATION: The agent profile is available to all sites at your enterprise.\n\nSITE: The agent profile is available to a specific site.", "example": "SITE", "enum": [ "ORGANIZATION", "SITE" ] }, "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" }, "screenPopup": { "type": "boolean", "description": "Indicates whether to allow external pop-up screens(true) or not(false).", "example": true }, "lastAgentRouting": { "type": "boolean", "description": "This setting use only if your administrator enables the Last Agent Routing feature for your enterprise. Indicates whether to allow Last Agent Routing check box on the Agent Desktop during wrap-up(true) or not(false).", "example": true }, "autoWrapUp": { "type": "boolean", "description": "Indicates whether to allow auto wrap-up(true) or not(false).", "example": true }, "autoAnswer": { "type": "boolean", "description": "Indicates whether incoming calls on the Agent Desktop need to be answered automatically(true) or not(false).", "example": true }, "autoWrapAfterSeconds": { "type": "integer", "description": "This setting allows auto wrap-up after seconds", "format": "int32", "example": 15 }, "agentAvailableAfterOutdial": { "type": "boolean", "description": "Enabled if you want the agent to go into the Available state after completing and wrapping up an outdial call. The agent can also manually select an Idle state from the STATUS NOW drop-down list before selecting a wrap-up code.\n", "example": true }, "allowAutoWrapUpExtension": { "type": "boolean", "description": "Indicates whether to allow auto wrap-up extension(true) or not(false).", "example": true }, "accessWrapUpCode": { "type": "string", "description": "Specify the wrap-up codes that the agents can select when they wrap up a contact.It can take one of these values:\n\nALL \u2014 To make all wrap-up codes available.\n\nSPECIFIC \u2014 To make specific codes available.\n\n", "example": "ALL", "enum": [ "SPECIFIC", "ALL", "PROVISIONED_VALUE", "NONE" ] }, "wrapUpCodes": { "uniqueItems": true, "type": "array", "description": "Specify the wrap-up codes list that the agents can select when they wrap up a contact.", "example": [ "WrapUp_Sale", "WrapUp_Field" ], "items": { "type": "string", "description": "Specify the wrap-up codes list that the agents can select when they wrap up a contact.", "example": "[\"WrapUp_Sale\",\"WrapUp_Field\"]" } }, "accessIdleCode": { "type": "string", "description": "Specify the Idle codes that the agents can select in Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all idle codes available.\n\nSPECIFIC \u2014 To make specific codes available.\n\n", "example": "ALL", "enum": [ "SPECIFIC", "ALL", "PROVISIONED_VALUE", "NONE" ] }, "idleCodes": { "uniqueItems": true, "type": "array", "description": "Specify the Idle codes list that the agents can select in Agent Desktop.", "example": [ "aux_code_sale", "aux_code2" ], "items": { "type": "string", "description": "Specify the Idle codes list that the agents can select in Agent Desktop.", "example": "[\"aux_code_sale\",\"aux_code2\"]" } }, "accessQueue": { "type": "string", "description": "Specify the queues that the agents can select from the Queue drop-down list on the Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all queues available.\n\nSPECIFIC \u2014 To make specific queues available\n\nNONE \u2014 If you do not want to make any queues available as transfer targets.\n\n", "example": "ALL", "enum": [ "SPECIFIC", "ALL", "PROVISIONED_VALUE", "NONE" ] }, "queues": { "uniqueItems": true, "type": "array", "description": "Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.", "example": [ "apim_queue_516789", "apim_queue_6123456" ], "items": { "type": "string", "description": "Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.", "example": "[\"apim_queue_516789\",\"apim_queue_6123456\"]" } }, "accessEntryPoint": { "type": "string", "description": "Specify the entry points that the agents can select from the Entry Point drop-down list on the Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all entry points available.\n\nSPECIFIC \u2014 To make specific entry points available\n\nNONE \u2014 If you do not want to make any entry points available as transfer targets.\n\n", "example": "ALL", "enum": [ "SPECIFIC", "ALL", "PROVISIONED_VALUE", "NONE" ] }, "entryPoints": { "uniqueItems": true, "type": "array", "description": "Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.", "example": [ "apim_entry_516789", "apim_entry_6123456" ], "items": { "type": "string", "description": "Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.", "example": "[\"apim_entry_516789\",\"apim_entry_6123456\"]" } }, "accessBuddyTeam": { "type": "string", "description": "Specify the teams that the agents can select from the Agent drop-down list on the Agent Desktop. It can take one of these values:\n\nALL \u2014 To make the agents on all teams available.\n\nSPECIFIC \u2014 To make agents on specific teams available, then select teams from the drop-down list\n\nNONE \u2014 If you do not want to make any teams available for consultation, conference, or call transfer.\n\n", "example": "ALL", "enum": [ "SPECIFIC", "ALL", "PROVISIONED_VALUE", "NONE" ] }, "buddyTeams": { "uniqueItems": true, "type": "array", "description": "Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.", "example": [ "5_Jan_Testing", "7_Feb_Testing" ], "items": { "type": "string", "description": "Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.", "example": "[\"5_Jan_Testing\",\"7_Feb_Testing\"]" } }, "consultToQueue": { "type": "boolean", "description": "Indicates whether you want the agent to be able to select a queue in the Queue drop-down list as a target for a consultation or not.", "example": true }, "outdialEnabled": { "type": "boolean", "description": "Indicates whether you want the agent to be able to make outdial calls(true) or not(false).", "example": true }, "outdialEntryPointId": { "type": "string", "description": "If you enabled Outdial, specify the entry point id that the agent can use to make outdial calls.", "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d" }, "outdialANIId": { "type": "string", "description": "This setting occurs only if you enabled Outdial. Specify the Outdial ANI id that the agent can use to make outdial calls.", "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d" }, "addressBookId": { "type": "string", "description": "Specify the address book id that includes the speed-dial numbers that the agent can select to make outdial and consult calls.", "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d" }, "dialPlanEnabled": { "type": "boolean", "description": "Indicates whether you want the agent to be able to make ad-hoc outdial calls(true) or not(false).", "example": true }, "dialPlans": { "uniqueItems": true, "type": "array", "description": "This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. ", "example": [ "US", "Any Format" ], "items": { "type": "string", "description": "This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. ", "example": "[\"US\",\"Any Format\"]" } }, "timeoutDesktopInactivityCustomEnabled": { "type": "boolean", "description": "This setting enabled time out desktop inactivity feature.", "example": true }, "showUserDetailsMS": { "type": "boolean", "description": "Specify whether the show user details of microsoft account user enabled or not", "example": true }, "stateSynchronizationMS": { "type": "boolean", "description": "Specify whether the state synchronization of microsoft account user enabled or not", "example": true }, "showUserDetailsWebex": { "type": "boolean", "description": "Specify whether the show user details of webex account user enabled or not", "example": true }, "stateSynchronizationWebex": { "type": "boolean", "description": "Specify whether the state synchronization of webex account user enabled or not", "example": true }, "timeoutDesktopInactivityMins": { "maximum": 10000, "minimum": 3, "type": "integer", "description": "This setting occurs only if you enabled time out desktop inactivity feature. Specify time in minute(s).", "format": "int32", "example": 5 }, "agentDNValidation": { "type": "string", "description": "Specify Unrestricted to allow agents to use any DN to log in to the Agent Desktop. \nTo restrict the DN that the agent can enter, select one of the following. \nProvisioned Value restricts the login DN to the default value that you provision for the agent. \nValidation Criteria restricts the login DN to the format specified in the Validation Criteria setting.\n", "example": "SPECIFIC", "enum": [ "SPECIFIC", "ALL", "PROVISIONED_VALUE", "NONE" ] }, "agentDNValidationCriteria": { "type": "string", "description": "This setting occurs only if you select Validation Criteria in the Validation For Agent DN.", "example": "SPECIFIC", "enum": [ "SPECIFIC", "ALL", "PROVISIONED_VALUE", "NONE" ] }, "agentDNValidationCriterions": { "uniqueItems": true, "type": "array", "description": "This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.", "example": [ "DN_5_Sept", "DN_7_Jan" ], "items": { "type": "string", "description": "This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.", "example": "[\"DN_5_Sept\",\"DN_7_Jan\"]" } }, "loginVoiceOptions": { "uniqueItems": true, "type": "array", "description": "List of Login Voice Options", "example": [ "AGENT_DN", "EXTENSION" ], "items": { "type": "string", "description": "Login voice options.", "example": "AGENT_DN", "enum": [ "AGENT_DN", "EXTENSION", "BROWSER" ] } }, "viewableStatistics": { "$ref": "#/components/schemas/viewableStatistics" }, "thresholdRules": { "uniqueItems": true, "type": "array", "description": "The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.\nIf your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.", "example": [ "Threshold_monitor_agent", "Threshold_call_data" ], "items": { "type": "string", "description": "The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.\nIf your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.", "example": "[\"Threshold_monitor_agent\",\"Threshold_call_data\"]" } }, "active": { "type": "boolean", "description": "Specify whether the agent profile is active or not Active.", "example": true }, "systemDefault": { "type": "boolean", "description": "Indicates whether the created resource is system created or not", "example": false }, "createdTime": { "type": "integer", "description": "Creation time(in epoch millis) of this resource.", "format": "int64", "readOnly": true, "example": 1617536244000 }, "lastUpdatedTime": { "type": "integer", "description": "Time(in epoch millis) when this resource was last updated.", "format": "int64", "readOnly": true, "example": 1617536244000 } } }