Webex · Schema
AgentProfileBulkExportDTO
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Enter a name for the agent profile. |
| description | string | (Optional) Enter a description of the profile. |
| parentType | string | This can be the following ORGANIZATION: The agent profile is available to all sites at your enterprise. SITE: The agent profile is available to a specific site. |
| siteId | string | Identifier for a site which is a physical contact center location under the control of your enterprise. |
| screenPopup | boolean | Indicates whether to allow external pop-up screens(true) or not(false). |
| lastAgentRouting | boolean | 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 |
| autoWrapUp | boolean | Indicates whether to allow auto wrap-up(true) or not(false). |
| autoAnswer | boolean | Indicates whether incoming calls on the Agent Desktop need to be answered automatically(true) or not(false). |
| autoWrapAfterSeconds | integer | This setting allows auto wrap-up after seconds |
| agentAvailableAfterOutdial | boolean | 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 befor |
| allowAutoWrapUpExtension | boolean | Indicates whether to allow auto wrap-up extension(true) or not(false). |
| accessWrapUpCode | string | Specify the wrap-up codes that the agents can select when they wrap up a contact.It can take one of these values: ALL — To make all wrap-up codes available. SPECIFIC — To make specific codes available |
| wrapUpCodes | array | Specify the wrap-up codes list that the agents can select when they wrap up a contact. |
| accessIdleCode | string | Specify the Idle codes that the agents can select in Agent Desktop.It can take one of these values: ALL — To make all idle codes available. SPECIFIC — To make specific codes available. |
| idleCodes | array | Specify the Idle codes list that the agents can select in Agent Desktop. |
| accessQueue | string | 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: ALL — To make all queues available. SPECIFIC — To make specific queues |
| queues | array | Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop. |
| accessEntryPoint | string | 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: ALL — To make all entry points available. SPECIFIC — To ma |
| entryPoints | array | Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop. |
| accessBuddyTeam | string | 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: ALL — To make the agents on all teams available. SPECIFIC — To make ag |
| buddyTeamsList | array | |
| consultToQueue | boolean | 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. |
| outdialEnabled | boolean | Indicates whether you want the agent to be able to make outdial calls(true) or not(false). |
| outdialEntryPoint | string | If you enabled Outdial, specify the entry point id that the agent can use to make outdial calls. |
| addressBook | string | Specify the address book id that includes the speed-dial numbers that the agent can select to make outdial and consult calls. |
| dialPlanEnabled | boolean | Indicates whether you want the agent to be able to make ad-hoc outdial calls(true) or not(false). |
| dialPlans | array | 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. |
| outdialANI | string | This setting occurs only if you enabled Outdial. Specify the Outdial ANI id that the agent can use to make outdial calls. |
| agentDNValidation | string | Specify Unrestricted to allow agents to use any DN to log in to the Agent Desktop. To restrict the DN that the agent can enter, select one of the following. Provisioned Value restricts the login DN to |
| agentDNValidationCriteria | string | This setting occurs only if you select Validation Criteria in the Validation For Agent DN. |
| agentDNValidationCriterions | array | This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN. |
| agentStats | boolean | Indicates whether you want the agents to view their personal statistics in Agent Desktop or not. |
| accessQueueStats | string | This setting controls whether the agent can view statistics for all or some queues in the Agent Personal Statistics tab.It can take one of these values: ALL — To enable the agent to display statistics |
| viewableStatsQueue | array | This setting should be specified when Access Queue Statistics is SPECIFIC. |
| loggedInTeamStats | boolean | Indicates whether the agent can view statistics for the team or not. |
| accessTeamStats | string | This setting controls whether the agent can view statistics for all or some teams in the Agent Personal Statistics tab.It can take one of these values: ALL — To enable the agent to display statistics |
| viewableStatsTeam | array | |
| thresholdRules | array | The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature. If your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the |
| loginVoiceOptions | array | List of Login Voice Options |
| showUserDetailsMS | boolean | Specify whether the show user details of microsoft account user enabled or not |
| stateSynchronizationMS | boolean | Specify whether the state synchronization of microsoft account user enabled or not |
| showUserDetailsWebex | boolean | Specify whether the show user details of webex account user enabled or not |
| stateSynchronizationWebex | boolean | Specify whether the state synchronization of webex account user enabled or not |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/AgentProfileBulkExportDTO",
"title": "AgentProfileBulkExportDTO",
"required": [
"accessBuddyTeam",
"accessEntryPoint",
"accessIdleCode",
"accessQueue",
"accessQueueStats",
"accessTeamStats",
"accessWrapUpCode",
"agentDNValidation",
"name",
"parentType"
],
"type": "object",
"properties": {
"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"
},
"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": [
"ALL",
"SPECIFIC"
]
},
"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"
},
"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"
},
"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"
},
"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"
},
"buddyTeamsList": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteTeamPairDTO"
}
},
"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
},
"outdialEntryPoint": {
"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"
},
"addressBook": {
"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\"]"
}
},
"outdialANI": {
"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"
},
"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"
},
"agentDNValidationCriteria": {
"type": "string",
"description": "This setting occurs only if you select Validation Criteria in the Validation For Agent DN.",
"example": "SPECIFIC"
},
"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\"]"
}
},
"agentStats": {
"type": "boolean",
"description": "Indicates whether you want the agents to view their personal statistics in Agent Desktop or not.",
"example": true
},
"accessQueueStats": {
"type": "string",
"description": "This setting controls whether the agent can view statistics for all or some queues in the Agent Personal Statistics tab.It can take one of these values:\n\nALL \u2014 To enable the agent to display statistics for all queues.\n\nSPECIFIC \u2014 Select Queues drop-down list to enable the agent to display statistics for specific queues.\n\nNONE \u2014 To prevent the agent from displaying queue statistics.\n\n",
"example": "SPECIFIC"
},
"viewableStatsQueue": {
"uniqueItems": true,
"type": "array",
"description": "This setting should be specified when Access Queue Statistics is SPECIFIC.",
"example": [
"apim_queue_516789",
"apim_queue_6123456"
],
"items": {
"type": "string",
"description": "This setting should be specified when Access Queue Statistics is SPECIFIC.",
"example": "[\"apim_queue_516789\",\"apim_queue_6123456\"]"
}
},
"loggedInTeamStats": {
"type": "boolean",
"description": "Indicates whether the agent can view statistics for the team or not.",
"example": true
},
"accessTeamStats": {
"type": "string",
"description": "This setting controls whether the agent can view statistics for all or some teams in the Agent Personal Statistics tab.It can take one of these values:\n\nALL \u2014 To enable the agent to display statistics for all teams.\n\nSPECIFIC \u2014 Select Teams drop-down list to enable the agent to display statistics for specific teams.\n\nNONE \u2014 To prevent the agent from displaying teams statistics.\n\n",
"example": "SPECIFIC"
},
"viewableStatsTeam": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteTeamPairDTO"
}
},
"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\"]"
}
},
"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"
]
}
},
"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
}
}
}