Type alias DesktopProfileResponse

DesktopProfileResponse: {
    accessBuddyTeam: string;
    accessEntryPoint: string;
    accessIdleCode: string;
    accessQueue: string;
    accessWrapUpCode: string;
    active: boolean;
    addressBookId: string;
    agentAvailableAfterOutdial: boolean;
    agentDNValidation: string;
    agentDNValidationCriterions: string[];
    agentPersonalGreeting: boolean;
    allowAutoWrapUpExtension: boolean;
    autoAnswer: boolean;
    autoWrapAfterSeconds: number;
    autoWrapUp: boolean;
    buddyTeams: string[];
    consultToQueue: boolean;
    createdTime: number;
    description: string;
    dialPlanEnabled: boolean;
    dialPlans: string[];
    entryPoints: string[];
    id: string;
    idleCodes: string[];
    lastAgentRouting: boolean;
    lastUpdatedTime: number;
    loginVoiceOptions: LoginOption[];
    name: string;
    outdialANIId: string;
    outdialEnabled: boolean;
    outdialEntryPointId: string;
    parentType: string;
    queues: string[];
    screenPopup: boolean;
    showUserDetailsMS: boolean;
    showUserDetailsWebex: boolean;
    stateSynchronizationMS: boolean;
    stateSynchronizationWebex: boolean;
    systemDefault: boolean;
    thresholdRules: Record<string, string | number>[];
    timeoutDesktopInactivityCustomEnabled: boolean;
    timeoutDesktopInactivityMins: number;
    viewableStatistics: {
        accessQueueStats: string;
        accessTeamStats: string;
        agentStats: boolean;
        contactServiceQueues: string[];
        id: string;
        loggedInTeamStats: boolean;
        teams: string[];
    };
    wrapUpCodes: string[];
}

Represents the response from getDesktopProfileById method.

Type declaration

  • accessBuddyTeam: string

    Access control for buddy teams assigned to the agent.

  • accessEntryPoint: string

    Access control for entry points assigned to the agent.

  • accessIdleCode: string

    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.

  • accessQueue: string

    Access control for queues assigned to the agent (ALL or SPECIFIC).

  • accessWrapUpCode: string

    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.

  • active: boolean

    Whether the agent profile is currently active.

  • addressBookId: string

    Address book ID of the agent.

  • agentAvailableAfterOutdial: boolean

    Agent available after outdial.

  • agentDNValidation: string

    Agent DN validation of the agent.

  • agentDNValidationCriterions: string[]

    Additional DN validation criteria configured for the agent.

  • agentPersonalGreeting: boolean

    Whether the agent personal greeting is enabled.

  • allowAutoWrapUpExtension: boolean

    Allow auto wrap-up extension.

  • autoAnswer: boolean

    Auto answer allowed.

  • autoWrapAfterSeconds: number

    Auto wrap-up after seconds.

  • autoWrapUp: boolean

    Auto wrap-up allowed.

  • buddyTeams: string[]

    Buddy team identifiers available to the agent when access is SPECIFIC.

  • consultToQueue: boolean

    Consult to queue allowed.

  • createdTime: number

    Timestamp when the profile was created.

  • description: string

    Description of the agent profile.

  • dialPlanEnabled: boolean

    Dial plan enabled for the agent.

  • dialPlans: string[]

    Dial plans of the agent.

  • entryPoints: string[]

    Entry point identifiers available to the agent when access is SPECIFIC.

  • id: string

    Unique identifier of the agent profile configuration.

  • idleCodes: string[]

    Idle codes list that the agents can select in Agent Desktop.

  • lastAgentRouting: boolean

    Last agent routing enabled for the agent.

  • lastUpdatedTime: number

    Timestamp when the profile was last updated.

  • loginVoiceOptions: LoginOption[]

    Represents the voice options of an agent.

  • name: string

    Display name for the agent profile.

  • outdialANIId: string

    Outdial ANI ID of the agent.

  • outdialEnabled: boolean

    Outdial enabled for the agent.

  • outdialEntryPointId: string

    Outdial entry point ID of the agent.

  • parentType: string

    Parent entity type for the profile (for example ORGANIZATION).

  • queues: string[]

    Queue identifiers available to the agent when access is SPECIFIC.

  • screenPopup: boolean

    Indicates whether screen pop is enabled.

  • showUserDetailsMS: boolean

    Show user details in Microsoft enabled or not.

  • showUserDetailsWebex: boolean

    Show user details in Webex enabled or not.

  • stateSynchronizationMS: boolean

    State synchronization in Microsoft enabled or not.

  • stateSynchronizationWebex: boolean

    State synchronization in Webex enabled or not.

  • systemDefault: boolean

    Whether this profile is the system default.

  • thresholdRules: Record<string, string | number>[]

    Threshold rules configured for the agent profile.

  • timeoutDesktopInactivityCustomEnabled: boolean

    Timeout desktop inactivity custom enabled.

  • timeoutDesktopInactivityMins: number

    Timeout desktop inactivity minutes.

  • viewableStatistics: {
        accessQueueStats: string;
        accessTeamStats: string;
        agentStats: boolean;
        contactServiceQueues: string[];
        id: string;
        loggedInTeamStats: boolean;
        teams: string[];
    }

    Viewable statistics of the agent.

    • accessQueueStats: string
    • accessTeamStats: string
    • agentStats: boolean
    • contactServiceQueues: string[]
    • id: string
    • loggedInTeamStats: boolean
    • teams: string[]
  • wrapUpCodes: string[]

    Wrap-up codes list that the agents can select when they wrap up a contact.

Settings

Member Visibility

Theme