Webex · Schema

UserProfileAppModuleDTO_UserResponseWithUserProfile

User Profile App Module DTO

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.
appModuleId string The code of a Webex Contact Center module. Please specify descriptions for each of these modules: m_provisioning - Refers to the provisioning module. Has access to Manage EntryPoints and Queues[f_mana
moduleAccessType string Indicates the access rights for a user of this profile for a Webex Contact Center module. It can take be one of these values: VIEW — A contact center user with this profile has read only access to a C
userProfileAppFeature array Specifies the module features(s) a user of this profile has access to.
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-userprofileappmoduledto-userresponsewithuserprofile-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserProfileAppModuleDTO_UserResponseWithUserProfile",
  "title": "UserProfileAppModuleDTO_UserResponseWithUserProfile",
  "type": "object",
  "description": "User Profile App Module DTO",
  "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
    },
    "appModuleId": {
      "type": "string",
      "description": "The code of a Webex Contact Center module. \n\nPlease specify descriptions for each of these modules:\n\nm_provisioning - Refers to the provisioning module. Has access to Manage EntryPoints and Queues[f_manage_entrypt_queue], Revoke API Key[f_revoke_api_key], DN Mappings[f_dn_mappings], Manage User Profiles[f_manage_user_profiles], Manage Tenants[f_manage_tenants], Manage Users[f_manage_users], Portal Branding[f_portal_branding], Audit Trail[f_audit_trail], Manage Sites[f_manage_sites], Manage Teams[f_manage_teams], and Manage Dial Plans[f_manage_dial_plans] features.\n\nm_real_time_reports - Refers to the real time reporting module. Has access to Summary View[f_summary_view], Agent State Change[f_agent_state_change], Real Time Threshold Alerts[f_realtime_threshold_alerts], and Web CallBack Report[f_web_callback_report] features.\n\nm_historical_reports - Refers to the historical reporting module.\n\nm_routing_strategy - Refers to the routing strategy module. Has access to Manage Media Files[f_manage_media_files] and Manage Call Flow Scripts[f_manage_call_flow_scripts] features.\n\nm_call_recording - Refers to the call recording module.\n\nm_call_monitoring - Refers to the call monitoring module. Has access to Barge In[f_barge_in], View Blind Monitor Request[f_view_blind_monitor_requests], Whisper Coach[f_whisper_coach], Mid Call Monitor[f_mid_call_monitor], and Restricted Monitor[f_restricted_monitor_only] features.\n\nm_reporting_analytics - Refers to the reporting analytics module. Has access to Analyzer Data Exchange[f_analyzer_data_exchange] and Business Rules[f_business_rules] features. \n\nm_recording_management - Refers to the recording management module. Has access to Tags[f_tags], Security Keys[f_security_keys], Manage Recordings[f_manage_recordings], and Custom Attributes[f_custom_attributes] features.\n\nm_agent_desktop - Refers to the agent desktop module.\n\nm_logout_agents - Refers to the agent logout module.\n\nm_manage_agent_states - Refers to the agent state module. Has access to Sign Out Agent[f_sign_out_agent] and Change Agent State[f_change_agent_state] features.\n\nm_additional_supervisory_features - Refers to the additional supervisory features module. Has access to Sign Out Agents[f_sign_out_agents], Change Agent States[f_change_agent_states] and Send Messages[f_send_messages] features.\n\nm_multimedia - Refers to the multimedia module. Has access to Provisioning[f_mm_provisioning], Basic Digital[f_mm_basic_digital], Social Channel[f_mm_social_channel] and Agent Desktop[f_mm_agent_desktop] features.\n\nm_agent_wellbeing - Refers to the Agent Wellbeing module. Has access to Agent Wellbeing provisioning features.\n\nm_auto_csat - Refers to the Auto Csat module.\n\nm_generated_summaries - Refers to the Generated Summaries module.\n\nm_agent_personal_greetings - Refers to the Agent Personal Greetings module.\n\nm_functions - Refers to the Functions in flow module.\n\nm_realtime_transcripts - Refers to the Realtime Transcripts module.\n\nm_suggested_responses - Refers to the Suggested Responses module.\n",
      "example": "m_provisioning",
      "minLength": 1
    },
    "moduleAccessType": {
      "type": "string",
      "description": "Indicates the access rights for a user of this profile for a Webex Contact Center module.\n\nIt can take be one of these values:\n\nVIEW \u2014 A contact center user with this profile has read only access to a Contact Center module.\n\nEDIT \u2014 A contact center user with this profile has read and write access to a Contact Center module.\n\nNONE \u2014 A contact center user with this profile cannot access the module.\n\n",
      "enum": [
        "NONE",
        "VIEW",
        "EDIT"
      ],
      "example": "EDIT"
    },
    "userProfileAppFeature": {
      "type": "array",
      "description": "Specifies the module features(s) a user of this profile has access to. \n",
      "items": {
        "$ref": "#/components/schemas/UserProfileAppFeatureDTO_UserResponseWithUserProfile"
      },
      "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": [
    "appModuleId",
    "moduleAccessType"
  ]
}