Webex · Schema

UserProfileAppFeatureDTO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
organizationId string ID of the contact center organization. This field is required for all bulk save operations.
id string ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
version integer The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
appFeatureId string The feature code of a Webex Contact Center module. Please add all the following features with their respective modules and set it's featureAccessType to 'ON' or 'OFF', to specify if it is in use. Here
appFeatureName string The feature name of the Webex Contact Center module.
featureAccessType string Indicates whether a user of this profile has access to a module feature. It can be one of these values: OFF — A contact center user with this profile cannot access this module feature. ON — A contact
createdTime integer This is the created time of the entity.
lastUpdatedTime integer This is the updated time of the entity.
View JSON Schema on GitHub

JSON Schema

webex-userprofileappfeaturedto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserProfileAppFeatureDTO",
  "title": "UserProfileAppFeatureDTO",
  "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
    },
    "appFeatureId": {
      "type": "string",
      "description": "The feature code of a Webex Contact Center module. \n\nPlease add all the following features with their respective modules and set it's featureAccessType to 'ON' or 'OFF', to specify if it is in use. Here is the complete list of Feature names and Feature Ids:\n\n\nFor module 'm_additional_supervisory_features' we have the following features:\n\nChange Agent States : f_change_agent_states\n\nSign out Agents : f_sign_out_agents\n\nSend Messages : f_send_messages\n\nRe-skill Agents : f_reskill_agents\n\nManage agent based queues : f_manage_agent_queue_assignments\n\nFor module 'm_real_time_reports' we have the following features:\n\nReal Time Threshold Alerts : f_realtime_threshold_alerts\n\nAgent State Change : f_agent_state_change\n\nSummary View : f_summary_view\n\nWeb Callback Report : f_web_callback_report\n\n\nFor module 'm_multimedia' we have the following features:\n\nMM Agent Desktop : f_mm_agent_desktop\n\nBasic Digital : f_mm_basic_digital\n\nMM Provisioning : f_mm_provisioning\n\nSocial Channel : f_mm_social_channel\n\n\nFor module 'm_reporting_analytics' we have the following features:\n\nAnalyzer Data Exchange : f_analyzer_data_exchange\n\nBusiness Rules : f_business_rules\n\n\nFor module 'm_manage_agent_states' we have the following features:\n\nChange Agent State : f_change_agent_state\n\nSign Out Agent : f_sign_out_agent\n\n\nFor module 'm_recording_management' we have the following features:\n\nCustom Attributes : f_custom_attributes\n\nManage Recordings : f_manage_recordings\n\nTags : f_tags\n\nSecurity Keys : f_security_keys\n\n\nFor module 'm_routing_strategy' we have the following features:\n\nManage Call Flow Scripts : f_manage_call_flow_scripts\n\nManage Media Files : f_manage_media_files\n\n\nFor module 'm_provisioning' we have the following features:\n\nManage EntryPoints and Queues : f_manage_teams\n\nManage Users : f_manage_users\n\nDN Mappings : f_dn_mappings\n\nManage Sites : f_manage_sites\n\nManage Teams : f_manage_teams\n\nManage User Profiles : f_manage_user_profiles\n\nRevoke API Key : f_revoke_api_key\n\nManage Dial Plans : f_manage_dial_plans\n\nManage Tenants : f_manage_tenants\n\nManage Entry Points and Queues : f_manage_entrypt_queue\n\nPortal Branding : f_portal_branding\n\nAudit Trail : f_audit_trail\n\nManage Business Hours : f_manage_business_hours\n\n\nFor module 'm_call_monitoring' we have the following features:\n\nMid Call Monitoring : f_mid_call_monitor\n\nBarge In : f_barge_in\n\nRestricted Monitor : f_restricted_monitor_only\n\nWhisper Coach : f_whisper_coach\n\nView Blind Monitor Request : f_view_blind_monitor_requests\n\n",
      "example": "f_manage_sites",
      "minLength": 1
    },
    "appFeatureName": {
      "type": "string",
      "description": "The feature name of the Webex Contact Center module.",
      "example": "Manage Sites"
    },
    "featureAccessType": {
      "type": "string",
      "description": "Indicates whether a user of this profile has access to a module feature.\n\nIt can be one of these values:\n\nOFF \u2014 A contact center user with this profile cannot access this module feature.\n\nON \u2014 A contact center user with this profile can access this module feature.\n\n",
      "enum": [
        "OFF",
        "ON"
      ],
      "example": "ON"
    },
    "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": [
    "appFeatureId",
    "featureAccessType"
  ]
}