Type alias Profile

Profile: {
    addressBookId?: string;
    agentAnalyzerId?: string;
    agentDbId: string;
    agentDefaultWrapUpCode?: agentDefaultWrapupCode;
    agentId: string;
    agentMailId: string;
    agentName: string;
    agentPersonalStatsEnabled: boolean;
    agentProfileID: string;
    agentWrapUpCodes?: agentWrapUpCodes;
    allowConsultToQueue: boolean;
    analyserUserId?: string;
    campaignManagerAdditionalInfo?: string;
    currentTeamId?: string;
    defaultDn: string;
    defaultWrapupCode: string;
    deviceType?: LoginOption;
    dialPlan: DialPlan;
    dn?: string;
    enterpriseId: string;
    forceDefaultDn: boolean;
    forceDefaultDnForAgent: boolean;
    idleCodes: Entity[];
    idleCodesAccess?: "ALL" | "SPECIFIC";
    idleCodesList?: string[];
    isAdhocDialingEnabled: boolean;
    isAgentAvailableAfterOutdial: boolean;
    isAgentLoggedIn?: boolean;
    isAgentStateChangeEnabled?: boolean;
    isAnalyzerEnabled?: boolean;
    isBargeInEnabled?: boolean;
    isCallMonitoringEnabled?: boolean;
    isCampaignManagementEnabled: boolean;
    isEndCallEnabled: boolean;
    isEndConsultEnabled: boolean;
    isManagedQueuesEnabled?: boolean;
    isManagedTeamsEnabled?: boolean;
    isMidCallMonitoringEnabled?: boolean;
    isOutboundEnabledForAgent: boolean;
    isOutboundEnabledForTenant: boolean;
    isRecordingManagementEnabled?: boolean;
    isSendMessageEnabled?: boolean;
    isSignOutAgentsEnabled?: boolean;
    isTimeoutDesktopInactivityEnabled: boolean;
    lastIdleCodeChangeTimestamp?: number;
    lastStateAuxCodeId?: string;
    lastStateChangeTimestamp?: number;
    lcmUrl?: string;
    loginVoiceOptions?: LoginOption[];
    lostConnectionRecoveryTimeout: number;
    maskSensitiveData?: boolean;
    microsoftConfig?: {
        showUserDetailsMS?: boolean;
        stateSynchronizationMS?: boolean;
    };
    multimediaProfileId: string;
    orgId?: string;
    organizationIdleCodes?: Entity[];
    outDialEp: string;
    outdialANIId?: string;
    privacyShieldVisible: boolean;
    regexOther: RegExp | string;
    regexUS: RegExp | string;
    siteId: string;
    skillProfileId: string;
    teams: Team[];
    tenantTimezone?: string;
    timeoutDesktopInactivityMins?: number;
    urlMappings?: URLMappings;
    webRtcEnabled: boolean;
    webexConfig?: {
        showUserDetailsWebex?: boolean;
        stateSynchronizationWebex?: boolean;
    };
    wrapUpData: WrapupData;
    wrapupCodes: Entity[];
}

Comprehensive agent profile configuration in the contact center system Contains all settings and capabilities for an agent

Type declaration

  • Optional addressBookId?: string

    Optional address book identifier

  • Optional agentAnalyzerId?: string

    Optional analyzer identifier for agent

  • agentDbId: string

    Database identifier for agent

  • Optional agentDefaultWrapUpCode?: agentDefaultWrapupCode

    Default wrap-up code for agent

  • agentId: string

    Unique identifier for the agent

  • agentMailId: string

    Email address for the agent

  • agentName: string

    Display name for the agent

  • agentPersonalStatsEnabled: boolean

    Whether personal statistics are enabled

  • agentProfileID: string

    Agent's profile configuration ID

  • Optional agentWrapUpCodes?: agentWrapUpCodes

    Agent-specific wrap-up codes

  • allowConsultToQueue: boolean

    Whether consult to queue is allowed

  • Optional analyserUserId?: string

    Optional analyzer user identifier

  • Optional campaignManagerAdditionalInfo?: string

    Additional campaign manager information

  • Optional currentTeamId?: string

    Current team identifier

  • defaultDn: string

    Agent's default dial number

  • defaultWrapupCode: string

    Default wrap-up code identifier

  • Optional deviceType?: LoginOption

    Current login device type

  • dialPlan: DialPlan

    Dial plan configuration for number handling

  • Optional dn?: string
  • enterpriseId: string

    Enterprise-wide identifier

  • forceDefaultDn: boolean

    Whether default DN is enforced at tenant level

  • forceDefaultDnForAgent: boolean

    Whether default DN is enforced for this agent

  • idleCodes: Entity[]

    Available idle codes

  • Optional idleCodesAccess?: "ALL" | "SPECIFIC"

    Access control for idle codes

  • Optional idleCodesList?: string[]

    List of specific idle codes

  • isAdhocDialingEnabled: boolean

    Whether ad-hoc dialing is enabled

  • isAgentAvailableAfterOutdial: boolean

    Whether agent becomes available after outdial

  • Optional isAgentLoggedIn?: boolean

    Whether agent is currently logged in

  • Optional isAgentStateChangeEnabled?: boolean

    Whether agent state changes are enabled

  • Optional isAnalyzerEnabled?: boolean

    Whether analyzer features are enabled

  • Optional isBargeInEnabled?: boolean

    Whether barge-in functionality is enabled

  • Optional isCallMonitoringEnabled?: boolean

    Whether call monitoring is enabled

  • isCampaignManagementEnabled: boolean

    Whether campaign management is enabled

  • isEndCallEnabled: boolean

    Whether ending calls is enabled

  • isEndConsultEnabled: boolean

    Whether ending consultations is enabled

  • Optional isManagedQueuesEnabled?: boolean

    Whether managed queues feature is enabled

  • Optional isManagedTeamsEnabled?: boolean

    Whether managed teams feature is enabled

  • Optional isMidCallMonitoringEnabled?: boolean

    Whether mid-call monitoring is enabled

  • isOutboundEnabledForAgent: boolean

    Whether outbound is enabled for this agent

  • isOutboundEnabledForTenant: boolean

    Whether outbound is enabled at tenant level

  • Optional isRecordingManagementEnabled?: boolean

    Whether recording management is enabled

  • Optional isSendMessageEnabled?: boolean

    Whether sending messages is enabled

  • Optional isSignOutAgentsEnabled?: boolean

    Whether signing out agents is enabled

  • isTimeoutDesktopInactivityEnabled: boolean

    Whether desktop inactivity timeout is enabled

  • Optional lastIdleCodeChangeTimestamp?: number

    Timestamp of last idle code change

  • Optional lastStateAuxCodeId?: string

    Last auxiliary code ID used for state change

  • Optional lastStateChangeTimestamp?: number

    Timestamp of last state change

  • Optional lcmUrl?: string

    Optional lifecycle manager URL

  • Optional loginVoiceOptions?: LoginOption[]

    Available voice login options

  • lostConnectionRecoveryTimeout: number

    Connection recovery timeout in milliseconds

  • Optional maskSensitiveData?: boolean

    Whether sensitive data masking is enabled

  • Optional microsoftConfig?: {
        showUserDetailsMS?: boolean;
        stateSynchronizationMS?: boolean;
    }

    Microsoft Teams integration configuration

    • Optional showUserDetailsMS?: boolean

      Whether to show user details in Teams

    • Optional stateSynchronizationMS?: boolean

      Whether to sync agent state with Teams

  • multimediaProfileId: string

    Multimedia profile defining channel capabilities

  • Optional orgId?: string

    Organization identifier

  • Optional organizationIdleCodes?: Entity[]

    Organization-wide idle codes

  • outDialEp: string

    Outbound entry point

  • Optional outdialANIId?: string

    Optional outbound ANI identifier

  • privacyShieldVisible: boolean

    Whether privacy shield feature is visible

  • regexOther: RegExp | string

    Regex pattern for international phone number validation

  • regexUS: RegExp | string

    Regex pattern for US phone number validation

  • siteId: string

    Site where agent is located

  • skillProfileId: string

    Skill profile defining agent competencies

  • teams: Team[]

    List of teams the agent belongs to

  • Optional tenantTimezone?: string

    Tenant timezone

  • Optional timeoutDesktopInactivityMins?: number

    Desktop inactivity timeout in minutes

  • Optional urlMappings?: URLMappings

    Integration URL mappings

  • webRtcEnabled: boolean

    Whether WebRTC is enabled

  • Optional webexConfig?: {
        showUserDetailsWebex?: boolean;
        stateSynchronizationWebex?: boolean;
    }

    Webex integration configuration

    • Optional showUserDetailsWebex?: boolean

      Whether to show user details in Webex

    • Optional stateSynchronizationWebex?: boolean

      Whether to sync agent state with Webex

  • wrapUpData: WrapupData

    Wrap-up configuration data

  • wrapupCodes: Entity[]

    Available wrap-up codes

Settings

Member Visibility

Theme